create-readme

create-readme is a tool that allows users to quickly and easily create README files with ChatGPT. By asking users a set of questions, create-readme generates a README based on the answers, eliminating the need to manually open OpenAI's website and type the prompt.

Key Features

• Simple command-based interface for generating README files
• Efficient and time-saving solution compared to manually typing prompts
• Effortless use - the tool asks you questions, you don't have to worry about describing everything in detail to it

Installation

To install create-readme, run the following command:

pipx install create-readme

Usage

To use create-readme, follow these steps:

1. Open your terminal.
2. Run the command:

create-readme my-awesome-project

3. Answer the prompted questions to provide the necessary information for the README file generation.
4. Once you have answered all the questions, create-readme will generate a README file based on your inputs.

Example

An example of a generated README is the file you're reading right now - it was manually cleaned up, but most of it is generated.