This is an open-source project about a README generator built on Streamlit and uses Pieces Python SDK. This project aims to simplify the process of creating a professional and informative README.md file for your projects.
To install the project and run it on your local machine, please follow the steps below:
-
Clone the repository:
git clone https://github.com/yourusername/readme-generator.git
-
Navigate to the project directory:
cd readme-generator -
Install the required dependencies:
pip install -r requirements.txt
-
Currently, Pieces Python SDK is facing an issue to resolve the validate_email issue, do this:
pip install --upgrade pydantic
-
Run the Streamlit app:
streamlit run generator.py
To use the README.md generator, simply provide a well-detailed desciption of your project click the 'Generate' button. The app will generate a README.md file based on the information you provided.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
NB: Please replace yourusername with your actual GitHub username in the clone URL.
Distributed under the MIT License. See LICENSE for more information.