How to learn from a GitHub project or list
This link goes to a GitHub page. It may be a list of lessons, a tutorial, or code to read.
Steps
- Open the link. You do not need an account to read a public GitHub page.
- Start with the README. It is the text shown below the file list. It tells you what the project is for.
- Look for a folder called docs, tutorial or examples. Those are the lessons.
- To get the code on your PC, click the green Code button, then Download ZIP. Unzip it. You do not need Git for this.
- Follow the README steps in order. If one step fails, read the Issues tab for the same error.
- Check the license (the LICENSE file) before you reuse code in your own project.
Make it work for you
- GitHub pages are long. Use the headings list in your screen reader to jump between sections.
- Press / on GitHub to open search, and T to find a file by name.
- Dark or high-contrast theme: GitHub Settings, then Appearance. Needs an account.
- Language: in Chrome or Edge, right-click the page and pick Translate. In Safari, use the page menu button, then Translate. The translation is by a machine, so check anything that looks odd.
- Read it aloud: Edge has Read aloud (Ctrl+Shift+U). Windows has Narrator (Win+Ctrl+Enter). Mac has VoiceOver (Cmd+F5). NVDA is a free screen reader for Windows.
- Make it bigger: press Ctrl and + (Cmd and + on a Mac). Reset with Ctrl+0.
- Keyboard only: Tab moves to the next link or button, Shift+Tab goes back, Enter opens it.
- Tire easily or lose focus? Work in short blocks, for example 15 minutes, then rest.