If it's your first time here, welcome!
This is GitHub, a service that hosts files (like Dropbox, Google Drive, or iCloud), and provides version control using Git. Specifically, this is the iAM.AMR project's start_here GitHub repository -- kind of like the welcome mat to our home on GitHub.
If you'd like to get to know more about Git and GitHub (which we strongly encourage), we suggest:
- the documentation
- GitHub's Hello World Guide, a 10 minute how-to that will walk you through creating your own repository (repo) on GitHub
- GitHub's Introductory Course, a free course on GitHub that will take less than one hour to complete
One of the best places to start is the iAM.AMR Organization's page (it's probably how you got here!). All project repos are listed there, and links to important repos are pinned to the top of the page. Very briefly;
- GitHub seperates sub-projects into repositories or repos
- Every repo has a README.md
- a repo is basically a folder
- the README is automatically displayed when you open the repo on GitHub
- READMEs are only shown for the top two levels of the repo
- the crumb at the top of the page will take you back to the iAM.AMR Organization's page
- this repo contains links to project and model directories
A release is a snapshot of a repository at a specific, notable moment in time, usually after new features are added and ready for general consumption. You should always check the repo for a recent release where available, as it may be the most stable version of the repo's contents.
The simplest way to get started is to download the entire repository as a ZIP file. Download a release (preferred; on the right hand side of the window), or use the green CODE button to download the current, main-branch copy.
Use a GitHub Desktop client (like GitHub Desktop or Source Tree).