GitHub Desktop

• Contribute directly via GitHub's web interface: This is the simplest method. If you are a beginner or if you plan to make only a few minor contributions, this option is probably the best for you;
• Contribute locally using Git: This method is more suitable if you plan to make regular or significant contributions to the Plan ₿ Academy. Although setting up your local Git environment on your computer may seem complex at first, this approach is more efficient in the long run. It allows for more flexible management of changes. If you are new to this, don't worry, we explain the entire process of setting up your environment in this tutorial (promise, you won't need to type any command lines ^^).

GitHub AccountHow to create your own account on GitHub?

• To start, you will obviously need a GitHub account. If you already have one, you can log in, otherwise, you can use our tutorial to create a new one.

GitHub AccountHow to create your own account on GitHub?

Step 1: Install GitHub Desktop

• Go to https://desktop.github.com/ to download the GitHub Desktop software. This software allows you to interact easily with GitHub, without having to use a terminal:
• When you first launch the software, you will be asked to connect your GitHub account. To do this, click on Sign in to GitHub.com:
• An authentication page will open in your browser. Enter your email address and password chosen when creating your account, then click on the Sign in button:
• Click on Authorize desktop to confirm the connection between your account and the software:
• You will be automatically redirected to the GitHub Desktop software. Click on Finish:
• If you have just created your GitHub account, you will be redirected to a page indicating that you have not yet created any repositories. At this point, set aside the GitHub Desktop software; we will return to it later:

Step 2: Install Obsidian

• Go to https://obsidian.md/download and download the software:
• Install Obsidian, launch the software, choose your language, and then click on Quick Start:
• You will arrive at the Obsidian software. For now, you have no files open:

Step 3: Fork the Plan ₿ Academy repository

• Go to the Plan ₿ Academy data repository at the following address: https://github.com/PlanB-Network/bitcoin-educational-content:
• From this page, click on the Fork button at the top right of the window:
• In the creation menu, you can leave the default settings. Make sure the Copy the dev branch only box is checked, then click on the Create fork button:
• You will then arrive at your own fork of the Plan ₿ Academy repository: This fork constitutes a separate repository from the original, although it currently contains the same data. You will now work on this new repository.

We have, in a way, made a copy of the Plan ₿ Academy source repository. Your fork (the copy) and the original repository will now evolve independently of each other. On the original repository, other contributors may add new data, while you, on your fork, will proceed with your own modifications. To maintain consistency between these two repositories, it will be necessary to synchronize them periodically so that they retrieve the same information. To send your changes to the source repository, you will use what is called a Pull Request. And to integrate changes from the source repository into your fork, you will use the Sync fork command available on the GitHub web interface.

Step 4: Clone the fork

• Return to the GitHub Desktop software. By now, your fork should appear in the Your repositories section. If you don't see it immediately, use the double arrow button to refresh the list. When your fork appears, click on it to select it:
• Then click on the blue button: Clone [username]/bitcoin-educational-content:
• Keep the default path. To confirm, click on the blue Clone button:
• Wait while GitHub Desktop clones your fork locally:
• After cloning the repository, the software offers you two options. You must select the first one: To contribute to the parent project. This choice will allow you to present your future work as a contribution to the parent project (Plan ₿ Academy/bitcoin-educational-content), and not exclusively as a modification of your personal fork ([username]/bitcoin-educational-content). Once the option is chosen, click on Continue:
• Your GitHub Desktop is now correctly configured. Now, you can leave the software open in the background to follow the modifications we will make. What we have achieved at this stage is the creation of a local copy of your repository, which is hosted on GitHub. As a reminder, this repository is a fork of the source repository of Plan ₿ Academy. You will be able to make modifications to this local copy, such as adding tutorials, translations, or corrections. Once these modifications are made, you will use the Push origin command to send your local modifications to your fork hosted on GitHub.

Step 5: Create a new Obsidian vault

• Open the Obsidian software and click on the small vault icon at the bottom left of the window:
• Click on the Open button to open an existing folder as a vault:
• Your file explorer will open. You need to locate and select the folder titled GitHub, which should be in your Documents directory among your files. This path corresponds to the one you established during step 4. After choosing the folder, confirm its selection. The creation of your vault on Obsidian will then launch on a new page of the software:

-> Attention, it is important not to choose the bitcoin-educational-content folder when creating a new vault in Obsidian. Instead, select the parent folder, GitHub. If you select the bitcoin-educational-content folder, the configuration folder .obsidian, containing your local Obsidian settings, will automatically be integrated into the repository. We want to avoid this, as it is not necessary to transfer your Obsidian configurations to the Plan ₿ Academy repository. An alternative is to add the .obsidian folder to the .gitignore file, but this method would also modify the .gitignore file of the source repository, which is not desirable.

• On the left side of the window, you can see the file tree with your different GitHub repositories that have been cloned locally.
• By clicking on the arrows next to the folder names, you can expand them to access the subfolders of the repositories and their documents:
• Don't forget to set Obsidian to dark mode: "Light attracts bugs" ;)

Step 6: Install a Code Editor

• Install one of these software programs, and keep it aside for your future modifications. Congratulations! Your work environment is now set up to contribute to Plan ₿ Academy. You can now explore our other specific tutorials for each type of contribution (translation, proofreading, writing.