A command-line application that allows you to quickly create a professional README.md
for a new project.
To install/use Team Profile Generator
and it's dependecies, you will first need to have Node.JS installed on your machine.
Once you have Node.js installed continue with the following steps:
- Step 1
- Clone/Fork Repo on to local machine.
- Step 2
- Open terminal from root of
README-generator
Repo and install dependencies with the following commands:
npm install
- Open terminal from root of
- Step 1
- Open terminal from root of
Team Profile Generator
Repo.
- Open terminal from root of
- Step 2
- run the command:
node index.js
- Step 3
- Answer pompts
- Step 4
- When all prompts are answered a
team.html
file will be generated and saved to the./output/
folder.
- When all prompts are answered a
This application is covered under the GNU GPL v3 License.
For contributions you may contact me here.
Visit my GitHub profile.