✍️ writeme

Cross-platform Auto-generate README.md for dev projects

writeme is a project designed to simplify the process of creating a comprehensive README.md file for software development projects. The primary purpose of writeme is to automatically extract relevant information from your project and generate for you a well-formatted README.md file that includes important details such as project name, description, repository name, usage and configuration steps, funding details, and collaborators.

writeme primarily extracts information from the project's configuration file. The specific type of configuration file depends on the project, but popular examples include Cargo.toml, package.json, composer.json, and others. To get the best from writeme, take a look at your configuration files

Table of Contents

• Table of Contents
  • ⚙️ Configuration
  • ⬇️ Installation
    • Cargo
    • Homebrew
  • 🎈 Usage
• 📄 License
• ✍️ Authors

⚙️ Configuration

If you choose to install the application using cargo, make sure you have the rust toolchain installed on your machine. You can find the installation instructions here.

⬇️ Installation

Cargo

cargo install writeme

Homebrew

brew tap writeme-project/writeme && brew install writeme

🎈 Usage

As simple as writing:

writeme 

or to select a different path

writeme --path 'path/to/your/project'

Use writeme --help to see all the available options.

If you are interested in learning more read the wiki

📄 License

GNU General Public License

✍️ Authors

auto-generated by writeme