RMGenie is a large-scale Open Source Software (OSS) generation system, designed to write your readme in a flash, say goodbye to tedious readme writing.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
RMGenie is a large-scale Open Source Software (OSS) generation system, designed to write your readme in a flash, say goodbye to tedious readme writing.
⏬installation guide
Install the extension in the VS Code IDE, and then you can start using it.
Click on the Extensions view icon on the Sidebar, or press Ctrl+Shift+X (Cmd+Shift+X on macOS). This will open the Extensions view.In the Extensions view, search for "RMGenie" and click on the Install button next to it.
🚀Get Started
Open the command line (you can do this by pressing Ctrl+Shift+P), type "Get Readme", press Enter,and then you can start using it.
Follow the steps below:
Enter the name of the repository you want to generate.
Choose the generation mode: project introduction, installation guide, operation instruction, functions and commands, complete README document.
Click the button to proceed with generation.
Then, you can obtain the README content generated by the open-source software's large model and then copy them into your documentation.