Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aniraannu/readme-generator
https://github.com/aniraannu/readme-generator
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/aniraannu/readme-generator
- Owner: aniraannu
- Created: 2024-05-29T20:44:18.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-04T19:14:26.000Z (8 months ago)
- Last Synced: 2024-06-05T18:54:43.227Z (7 months ago)
- Language: JavaScript
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# README Generator
A node.js application that uses user input from inquirer to populate a README.md file for user repository.
## Description
Every good project needs a quality README with information about the app - what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions so that other developers are more likely to use and contribute to the success of the project.
This is a command-line application that runs with Node.js that dynamically generates a README.md file based on input about your project. Check out the ExampleREADME.md in this repo as an example.
## Getting Started
To generate your own README, git clone the repo down to your local so you have the Node project on your local. Run npm install in order to install the following npm package dependencies as specified in the package.json:
* Inquirer will prompt you for your inputs from the command line.
* The application will start by running node index.js in the command line.
* Answer the prompts in your command line to generate the README.
After answering all the prompts, your README file will be named 'ExampleREADME.md' and will be ready for you at the root of the repo.
### Dependencies
* Inquirer: V 8.2.4
### Installing
* npm init
* npm install inquirer
### Executing program
* The repo can be cloned from the following location :
[GitHub-README-generator](https://github.com/aniraannu/README-generator)
* The application will be invoked by using the following command:
```bash
node index.js
```
## Help
NA
## Authors
Contributors names and contact info
Anira Raveendran
[@aniraannu](https://github.com/aniraannu)
## Version History
* 0.1
* Initial Release
## License
None
## Acknowledgments
Inspiration, code snippets, etc.
* [dbader](https://github.com/dbader/readme-template)