writeme-project / writeme

Cross-platform README.md generator
GNU General Public License v3.0
14 stars 0 forks source link
developer-tools open-source readme readme-generator readme-template rust utility writeme

✍️ writeme

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

animated

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](https://www.rust-lang.org/tools/install). ## ⬇️ Installation ### Cargo ```bash cargo install writeme ``` ### Homebrew ```bash brew tap writeme-project/writeme && brew install writeme ``` ## 🎈 Usage As simple as writing: ```bash writeme ``` or to select a different path ```bash 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](https://github.com/writeme-project/writeme/wiki) # 📄 License GNU General Public License # ✍️ Authors
contrib.rocks image

auto-generated by writeme