samueltuoyo15/Dokugen: Dokugen is an open source command-line tool that automatically generates high-quality README.md files for your projects. It analyzes your project structure and code to create a comprehensive and professional README, saving you time and effort.

A CLI tool to automatically generate high-quality README files for your projects. Spend less time on documentation and more time building!

Dokugen scans your project, analyzes the file structure and code, and then generates a comprehensive README.md file based on your project type and key characteristics. It supports various languages and frameworks, including JavaScript/TypeScript, Python, Go, and more. It also asks you key questions like “Does your project use Docker?” to improve the output.

To install Dokugen globally and make it accessible from any project directory, run:

Navigate to your project’s root directory in the terminal and run the following command:

The tool will guide you through a few questions to customize the README generation process. If a README.md already exists, you will be prompted to overwrite it.

Here’s an example of running Dokugen in a project directory:

cd my-awesome-project
dokugen generate

The tool will then generate a README.md file in your project’s root.

Contributions are welcome! Feel free to submit pull requests with improvements, bug fixes, or new features.

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes.
4. Submit a pull request.

This project is open-source and available under the MIT License. See the LICENSE file for more information.

This project uses the following open-source libraries: