Go to shields.io to see what other badges you can add to your projects (to use the ones above, just change to your username and repo)
Ever needed a professional README layout but didn't know where to start? Use this template to quickly develop a professional README.
Change the sections with your own text.
You can add code blocks and other font stylings to your README via the markdown syntax, look at this mastering markdown link for more information.
Solves the programmer's most gruelling and hated task, documentation.
Put what skills you learnt or advanced upon here.
You can view the website link here.
- Description
- User Story
- Screenshots
- Installation
- Features
- Technology
- Contributors
- Acknowledgements
- Testing
- License
- Questions
GIVEN a basic application description (e.g. GIVEN a command line application that accepts user input)
WHEN I do something (e.g. WHEN I click a button)
THEN some action happens (e.g. THEN I am redirected to repo owner's Github page)
Repeat WHEN and THEN until all major project needs have been defined
You will need: Github, VS Code, Gitbash
-
Click Use this Template
-
Enter a name for your repo
-
Git clone new repo to your computer by right clicking SSH link in your repo, then open gitbash and type:
'git clone'
Then right click next to git clone text and your SSh link will be pasted in for you, hit enter and wait as it compiles
-
Open the repo in your editor software and edit the README to your values
- Clickable table of contents
- Easily modifiable for more sections, more images, etc
- Badges
List tech stack you used to create your project here (e.g. Node.js, Inquirer npm package, Github API)
- Github
You can also contribute by opening a pull request or submitting an issue
Put url's of website's that helped you in creating your project here. E.g.
List any unit tests you've created for your project here
This is the licence conditions you apply to your project (e.g. limitations on how it can be used, if they need to attribute you as the creator).
Remember to change the copyright text to the current year and your name!
View licences available at choosealicence website
MIT
Copyright 2021 Zachary Hobba
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.
Change these to your values
Find me on Github at HobbaZ Email me at zachobba@gmail.com