OSS Readme Generator

OSS Readme Generator

What's OSS Readme Generator

OSS Readme Generator 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 "OSS Readme Generator" 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:

1. Enter the name of the repository you want to generate.

2. Choose the generation mode: project introduction, installation guide, operation instruction, functions and commands, complete README document.

3. 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.