A command line-based README generator that automatically handles some of the trickier aspects of license messaging. A video demonstration of this application can be found on YouTube.
This application requires Node.js and npm to run. To run this application, download the code to your computer via a git clone or a zip download. Navigate to that directory and run npm install to install all dependencies, then run node index.js to run the application.
This application can be used to generate a nice-looking README for your open-source projects.
Although this application is no longer under active development, I welcome any and all pull requests from those who would like to contribute to and improve this software.
This software currently does not have any tests.
Check me out on GitHub
Send me an email at kurtbixby@utexas.edu
MIT License
Copyright (c) 2022 kurtbixby
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.