Cross-platform README generator for your project
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
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.
bash
cargo install writeme
bash
brew install writeme
As simple as:
bash
writeme --path 'path/to/your/project'
Use writeme --help to see all the available options.
MIT OR Apache-2.0
🎉 Thank you for being interested in contributing to project! 🎉
Feel welcome and read the following sections in order to know how to ask questions and how to work on something.
Please make sure you are welcoming and friendly in all of our spaces. 👍
The best way to contribute to our projects is by opening a new issue or tackling one of the issues that are already open.
Pull requests are great if you want to add a feature or fix a bug. Here's a quick guide: 1. Fork the repo. documentation changes require no new tests. 1. Make sure to check out the Style Guide and ensure that your code complies with the rules. 2. Commit your changes. 3. Push to your fork and submit a pull request. Please provide us with some explanation of why you made the changes you made.
For commits it is recommended to use Conventional Commits.
The type must be one of the following:
The scope should be the name of the piece of the project affected.
The subject contains a succinct description of the change: