This is a program that is designed to build professionally formatted README.md files for use with programming projects.
It makes use of Inquirer to obtain information from the user about their project.
Please note - This README has been generated by this application.
- Download the package from this GitHub repository
- Navigate to the folder
- Perform a git install using the pacakages listed in package.json
- Thats it! You are ready to go!
The project will gather all information from you at runtime. To run this just execute the index.js file from the root directory of the project with node as follows:
node index.js
An example of me generating this very readme can be viewed on YouTube
No tests have been developed for this application at this time.
- Node.js
- Inquirer
- Regex
- James Prince
URL: https://choosealicense.com/licenses/mit/
MIT License
Copyright (c) James Prince
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.
If you wish to contribute to this project, please start by forking the repo to your own account. From there, feel free to do whatever you want!
If you wish to then request changes to the project be merged into the upstream project, create a pull request and the project maintainers will review and merge it.
Copyright © 2022, James Prince