readme-builder

README Builder

A command-line tool that automatically generates professional README files and licenses for your projects. Simply answer a few questions, and the tool will analyze your project structure, detect programming languages used, and create well-structured documentation.

Features

• Interactive command-line interface
• Automatic programming language detection
• License generation (MIT, Apache 2.0, GPL-3.0)
• Project structure analysis
• Build system detection
• Language statistics
• Cross-platform support

Installation

gem install readme_builder

Requirements

• Ruby >= 2.7.0
• C++17 compatible compiler
• CMake >= 3.14 (for building from source)

Usage

• Navigate to your project directory:

  cd /path/to/your/project
  

• Run the tool:

  readme_builder
  

• Follow the interactive prompts:

  Enter project title: My Awesome Project
  Enter project description: A fantastic tool that does amazing things
  Select license type:
  1. MIT
  2. Apache 2.0
  3. GPL-3.0
  Enter number (1-3): 1
  

The tool will then:

• Analyze your project directory
• Detect programming languages used
• Identify build systems
• Generate a comprehensive README.md
• Create a LICENSE file with your chosen license

Generated Files

README.md Structure

• Project title and description
• Installation instructions (based on detected build system)
• Usage section
• Project structure
• Language statistics
• License information

Supported Licenses

• MIT License
• Apache License 2.0
• GNU GPL v3.0

Example

Here's what happens when you run the tool:

$ readme_builder
Welcome to README Builder!

Enter project title: Weather App
Enter project description: A command-line weather forecast tool
Select license type:
1. MIT
2. Apache 2.0
3. GPL-3.0
Enter number (1-3): 1

Analyzing project structure...
Detecting languages...
Found: Python (80%), JavaScript (15%), CSS (5%)
Generating README.md...
Generating LICENSE...
Done! Created:
 - README.md
 - LICENSE

Contributing

• Fork the repository
• Create your feature branch (git checkout -b feature/amazing-feature)
• Commit your changes (git commit -am 'Add amazing feature')
• Push to the branch (git push origin feature/amazing-feature)
• Create a Pull Request

Development Setup

git clone https://github.com/yourusername/readme_builder
cd readme_builder
bundle install
rake compile  # Compiles native extensions
rake test     # Runs tests

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

Built with:

• Ruby for the command-line interface
• C++ for the core analysis engine
• Native extensions for seamless integration