Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theapache64/readgen
A simple tool to generate README
https://github.com/theapache64/readgen
gradle java kotlin
Last synced: 7 days ago
JSON representation
A simple tool to generate README
- Host: GitHub
- URL: https://github.com/theapache64/readgen
- Owner: theapache64
- Created: 2021-02-03T17:01:05.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-15T18:09:19.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T15:33:06.981Z (7 months ago)
- Topics: gradle, java, kotlin
- Language: Kotlin
- Homepage:
- Size: 20.4 MB
- Stars: 71
- Watchers: 1
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# readgen
> Tired of creating README? I got you covered.
### ✨ Demo
## 🛠 Installation
```
sudo npm install -g readgen-cli
```
## ⌨️ Usage
```shell script
Usage: read-gen [OPTIONS]
Options:
-f TEXT Custom font
-t TEXT Custom title
-s INT Font size
-c Cover only
-h, --help Show this message and exit
```
- To generate README.md, install.sh and cover image
```shell script
~$ readgen
```
- To generate cover image alone
```shell script
~$ readgen -c
```
## 🥼 Run tests
```shell script
./gradlew test
```
## ✍️ Author
👤 **theapache64**
* Twitter: @theapache64
* Email: [email protected]
Feel free to ping me 😉
## 🤝 Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any
contributions you make are **greatly appreciated**.
1. Open an issue first to discuss what you would like to change.
1. Fork the Project
1. Create your feature branch (`git checkout -b feature/amazing-feature`)
1. Commit your changes (`git commit -m 'Add some amazing feature'`)
1. Push to the branch (`git push origin feature/amazing-feature`)
1. Open a pull request
Please make sure to update tests as appropriate.
## ❤ Show your support
Give a ⭐️ if this project helped you!
## ☑️ TODO
- [ ] Add more cover image styles with different fonts
- [ ] Support Android projects
- [ ] Support SpringBoot projects
## 📝 License
```
Copyright © 2022 - theapache64
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
_This README was generated by [readgen](https://github.com/theapache64/readgen)_ ❤