When creating an open source project, a detailed README file makes all the difference in a developers repository. The README file will offer other developers all of the information and tools they need to install and run the application and give descriptive guidelines for addressing issues and making contributions.
README Generator offers a template md file for developers to fill out from the command line, allowing them to spend more time developing and less time thinking about formatting their README file.
- Clone repo
- Open integrated terminal on the root directory
- Install dependencies
npm i
- The app will generate a new directory in the root directory named for the title of the user's project
- root directory
- images
- demo.gif
- node_modules
- samples
- sample md files and pdf exports
- utils
- generateMarkdown.js
- .gitignore
- index.js
- package-lock.json
- package.json
- README.md
- NEW DIRECTORY
- README.MD
This is a command line app. The user will be able to input their responses in a single line format when prompted and use the return key to submit.
For checkbox prompts, the user will be able to navigate the options using the arrow keys, select using the space bar and submit using the return key.
User can use back-ticks without using the return key to enable code blocks
```code block here```
User can also format text with returns by typing designated command in-line
-r
App has been updated since the demo was recorded to color code prompts based on the shortcut permissions
- All shortcuts permitted -magenta
- Limited shortcuts permitted -yellow
As of now, README Generator is a simple prototype for what could become a more robust command line application. There are no immediate concerns regarding bugs but I encourage all users to test as they desire.
For information regarding contributions and reporting issues, see Contributing / Issues
Send emails to yoni@yondav.us
- Fork repo
- Make additions and changes on new, personalized branch
- Pull request and ask for review
Currently no known issues.
Report issues by selecting the issues tab and creating a new issue
This README file was built with README Generator
Copyright © 2021, Yoni David