This is a demo code repository for MINK WIC 2023 attendees to use to build their first GitHub repo. Sometimes it is easier to grab a template for a repository and use it to build your project instead of starting from scratch. This can be your template.
This file is called a README, which is why its named README.md. It is usually your first stop in any code or software, to understand the objectives and constraints of a code project, how to use it, and other helpful information. Here is a great description from GitHub:
"A README is often the first item a visitor will see when visiting your repository. README files typically include information on:
- What the project does
- Why the project is useful
- How users can get started with the project
- Where users can get help with your project
- Who maintains and contributes to the project"
A README file also typically includes a changelog documenting changes to the project over time, such as between releases of new versions.
Let's use that as a guideline for this README page!
For more information on how to copy this repository into your own account, click here: Getting Started
Once you have forked the repo, try to see if you can make your own Markdown file that matches mine without looking at the Markdown code!
Create a new Markdown file and see if you can replicate mine.
Examples of scripts are given below:
Check out this page for more resources on excellent GitHub resources you can check out for examples as well as other tutorials and style guides. You can download the slides from todays workshop at this link: MINK WIC 2023 Slides
Me, Kate Cooper. Contact me if you would like to contribute to this repo.
This project is licensed using GNU General Public License v2.0.
Every single project should have a license. Choose your own with www.choosealisence.com