ReadmeGen - AI Powered Readme File Generator, is a revolutionary tool that utilizes the power of Artificial Intelligence to generate professional and comprehensive README.md files for your GitHub repositories. With just a few clicks, you can have a detailed and informative README file that will help others understand the purpose, usage, and functionality of your project.

Features

• AI-powered readme generation
• User-friendly interface
• Ability to customize the generated readme
• Support for multiple programming languages
• Automatic creation of table of contents

Installation

To get started with ReadmeGen, follow these simple steps:

1. Fork the repository to your own GitHub account.
2. Clone the repository to your local machine using the following command:

git clone https://github.com/[your-username]/ReadmeGen.git

3. Navigate to the backend directory and install the required dependencies using pip:

pip install -r requirements.txt

4. Navigate to the frontend directory and install the required dependencies using npm:

npm install

5. Start the backend server by running the following command:

python backend/main.py 

OR

uvicorn main:app

6. Start the frontend development server by running the following command:

npm run dev

7. Open your web browser and navigate to http://localhost:3000 to access the ReadmeGen application.

Usage

To use ReadmeGen, simply follow these steps:

1. Enter the name of your project in the "Project Title" field.
2. Provide a detailed description of your project in the "Description" field.
3. List the features of your project in the "Features" field.
4. Provide instructions on how to install and use your project in the "Installation" and "Usage" fields.
5. If you would like others to contribute to your project, provide guidelines on how to do so in the "Contributing" field.
6. Choose a license for your project from the dropdown menu in the "License" field.
7. Click the "Generate Readme" button to generate your README.md file.
8. Review the generated README.md file and make any necessary modifications.
9. Copy the generated README.md file and paste it into the root directory of your GitHub repository.

Contributing

We welcome contributions from the community! If you would like to contribute to ReadmeGen, please follow these steps:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them to your branch.
4. Push your changes to your forked repository.
5. Open a pull request and describe your changes in detail.

License

ReadmeGen is released under the MIT License.