Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.47 KB

README.md

File metadata and controls

28 lines (19 loc) · 1.47 KB
Raw

READMEnot

Description

READMEnot is a powerful tool designed to automate the creation of README files for code repositories. By leveraging OpenAI's GPT-4 model, it intelligently identifies and extracts relevant information from the project's files to generate comprehensive and well-structured README sections. This tool simplifies the documentation process, ensuring that essential details about the project title, description, installation, usage, and configuration are accurately captured and formatted.

Installation

installation

Usage

To use the readme_generator.py script, follow these steps:

  1. Clone the Repository: Ensure you have the repository cloned to your local machine.

  2. Install Dependencies: Make sure you have the necessary dependencies installed. You can install the required packages using pip:

    pip install openai

  3. Set Up OpenAI API Key: The script requires an OpenAI API key to function. You will be prompted to enter your API key when you run the script.

  4. Run the Script: Execute the script by running the following command in your terminal:

    python readme_generator.py

  5. Provide the Path to the Repository: When prompted, enter the path to the repository for which you want to generate the README.

  6. Generated README: The script will analyze the files in the specified repository, generate the README content, and save it as GENERATED_README.md in the root of the provided repository path.