https://github.com/microcodeincorporated/templatereadme
MicroCODE README.md Template for new repositories.
https://github.com/microcodeincorporated/templatereadme
Last synced: 5 months ago
JSON representation
MicroCODE README.md Template for new repositories.
- Host: GitHub
- URL: https://github.com/microcodeincorporated/templatereadme
- Owner: MicroCODEIncorporated
- License: mit
- Created: 2022-03-05T18:50:10.000Z (over 4 years ago)
- Default Branch: Production
- Last Pushed: 2022-08-29T19:50:09.000Z (almost 4 years ago)
- Last Synced: 2025-05-19T11:45:41.519Z (about 1 year ago)
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-Template.md
- License: LICENSE
Awesome Lists containing this project
README
# Repository-Name
Brief description of the repository.
## Description
Detailed description of this repository.
## Getting Started
### Dependencies
* Dependency #1 - description.
* Dependency #2 - description.
### Installing
* Copy this file into your repository.
```
..\GitHub\README-Template> copy README-Template.md ..\GitHub\\README.md
```
* In you new repo edit the README.md and make specific to your project.
* Make notes here about installing your project
* Include images as needed in the \images folder as .PNGs
* Include videos as needed in the \videos folder as .MP4s
* Drag the video into your README.md once in GitHub and then copy the link in the code below.
Your browser does not support the HTML5 player.
## Help
Describe how to get help with this project.
## Terminology
| Word or Acronym | Description/Definition |
|-------------------|-------------------------------------------------------|
| Template | A file used to start others to ensure code and documentation consistency.
| ES5, ES6 | Different revsions of the JavaScript (ECMAScript) language standard.
| JavaScriptSG | MicroCODE's JavaScript Style Guide. (Available on GitHub).
| MERN | MongoDB, Express, React, Node JS.
| MongoDB | A ‘NoSQL’ database designed for Cloud applications, also referred to as a ‘Document Store’.
| Express | Express is *not* a database but rather an ‘extensible routing language’ for communication between a Client and a Server.
| React | A Web UI development system, a JavaScript library developed by Facebook and made public—and Open Source—since 2013.
| Node JS | A development stack that executes from a local file store—on a local Server—instead of from a network of remote servers on the Web.
## Authors
Contributors names and contact info
* Timothy J McGuire [GitHub @tjmcode] (https://github.com/tjmcode)
## Release History
* 0.1
* Various bug fixes and optimizations
* See [commit change]() or See [release history]()
* 0.0
* Initial Release
## Future Development
* 0.n
* New Feature: Short description
* New Feature: Short description
* Fix Defects: Short description
* Fix Defects: Short description
* 0.n+1
* New Feature: Short description
* New Feature: Short description
* Fix Defects: Short description
* Fix Defects: Short description
## License
This project is licensed under the MIT License - see the LICENSE.md file for details
## Acknowledgments
Inspiration, code snippets, etc.
* [AirBnb's JS StyleGuide](https://github.com/airbnb/javascript)