Skip to content

Commit 6ce6b50

Browse files
authored
Adjusted for offline repo use
Created Online Repository section from existing words Created new Offline section Added link to Git
1 parent 8dbdda6 commit 6ce6b50

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

docs/tutorial/2_creating_a_new_machine.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,22 @@ on your machine code. A VCS tracks changes to files and allows you to review,
3737
revert, and isolate changes to make sure you never lose progress or get your
3838
game into an irrecoverable bad state.
3939

40-
Additionally, using a repository means that you can share your code with others,
41-
which is important when asking for help and support.
40+
If you use an online repository you can share your code with others, which is
41+
important when asking for help and support.
4242

43-
The most popular system is Git, and you can use Git for free on GitHub. Follow these
44-
guides to get setup with a GitHub account and create a new repository, which will
43+
The most popular system is Git. You can use it online with services like GitHub,
44+
or use it locally to manage files on your computer. Either way you can use Git
45+
for free.
46+
47+
### Online Repository
48+
Follow these guides to get setup with a GitHub account and create a new repository, which will
4549
hold all the code for your game.
4650

4751
* [Create a GitHub account](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github)
4852
* [Create a new repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository)
4953
* [Clone your repository to your computer](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
5054

51-
If you follow these steps, you'll now have a folder on your computer that you can
55+
If you followed these steps, you'll now have a folder on your computer that you can
5256
sync with the online repository, track changes in, and share with others. This
5357
folder will be your machine folder, discussed in the next step.
5458

@@ -58,6 +62,23 @@ folder will be your machine folder, discussed in the next step.
5862

5963
For managing your repository, a desktop client can save a lot of headache. [SourceTree](https://www.sourcetreeapp.com) and [GitHub Desktop](https://desktop.github.com) are popular, easy-to-use choices.
6064

65+
### Offline Repository
66+
Why would I want to use Git locally? Well, you:
67+
* Might want to store files in your repository that incorporate intellectual property with restrictive rights that do not permit uploading to any online services
68+
* May have proprietary information in your repository
69+
* Could be embarrassed by your terrible code (don't be!)
70+
71+
Grab yourself a Git client - there are many fabulous choices, some free. You can get the Git client from Git - it comes with a GUI (git-gui), which makes setting up a repository fairly easy:
72+
* Make your machine folder
73+
* Run git-gui in the directory
74+
* Create your repository
75+
76+
[git-scm.com](https://git-scm.com/)
77+
78+
When you need to share your repository, you can always convert it to a Git repo, or make a new Git repo with a subset of files in it.
79+
80+
!!! tip "Some people use their GitHub repo as a backup. Using Git on a local repository provides significantly less protection, remember to back up properly!"
81+
6182
## 3. Your machine folder
6283

6384
Okay, so let's get started with your own game's machine folder.
@@ -105,7 +126,7 @@ C:\pinball\your_machine\config\config.yaml
105126
Note that if you're on Windows and you just right-click and select *New
106127
Text Document*, make sure that Windows Explorer is configured to show
107128
file extensions so you actually create a file called `config.yaml` and
108-
not `config.yaml.txt`. (That's in the "View" menu of Explorer.)
129+
not `config.yaml.txt`. Find the option in the "View" menu of Explorer.
109130

110131
## 4. Add #config_version=6 to the top of your config file
111132

0 commit comments

Comments
 (0)