Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thealbertdev/masb-obsidian


https://github.com/thealbertdev/masb-obsidian

Last synced: 17 days ago
JSON representation

Awesome Lists containing this project

README 

        
Welcome to the [MASB’s Obsidian Vault](https://github.com/TheAlbertDev/masb-obsidian). This repository is intended to be browsed using [Obsidian](https://obsidian.md/), a free note-taking application available for Windows, MacOS, Linux, Android and iOS. Once installed, you can clone and browse the contents of the repository. The Vault contains all the content seen during the course and link them to additional external resources that can help you during the journey. Following are the steps to follow to clone the repository and open the Obsidian vault from the application.

> [!INFO]

> If this your first time downloading this Vault, it is supposed that you don’t know what is Git and how it works yet. Don’t worry. For now, focus on following the steps below and we will see Git during this course 😉 

# 🚀Getting started

## Install Obsidian

1. Download and install [Obsidian](https://obsidian.md/download). [Here](https://help.obsidian.md/Getting+started/Download+and+install+Obsidian) you can find the official installation guide.

## Create a GitHub account

1. Create an account in [GitHub](https://github.com/join).

## Install and configure Git

1. Follow the instructions available in this [Git guide](https://github.com/git-guides/install-git) to install Git.

2. Set the username following [these instructions](https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git#setting-your-git-username-for-every-repository-on-your-computer) (set the username for every repository on your computer).

3. Set the email following [these instructions](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git) (set the email for every repository on your computer).

4. Create an SSH key to connect to GitHub following [these instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) (when generating the key, you can use a blank/empty password when requested).

5. Add the created key to your GitHub account following [these instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).

## Clone the repository

1. Create a workspace in a path without spaces nor “strange” characters like accents, diaeresis, etc. Only alphanumeric characters, dashes and/or underscores. For example, in Windows we can create a folder in `C:\masb`, in Linux or MacOS we can create a folder in `~/masb`.

   > [!WARNING]

   > If you do not follow step 1, you are going to get compilation issues during the course. 

2. Open a Git bash in the workspace. In Windows, right click the new folder and select “Git bash here”.

3. Go to the [GitHub repository page](https://github.com/TheAlbertDev/MASB) and copy the SSH URL available clicking in the green button `<> Code`.

4. In the Git bash, execute the command:

   ```bash

   git clone 

   ```

   Replace ``by the SSH URL you copied on step 3.

## Open the Obsidian Vault

1. Open Obsidian.

2. Open the course Vault located in `obsidian` folder in the repository clone in prior section following [these instructions](https://help.obsidian.md/Files+and+folders/Manage+vaults#Create+vault+from+an+existing+folder).

# 🎉From now on

From now on you have access to the full contents of the course. Use the [Obsidian’s official help](https://help.obsidian.md/Home) to navigate through the Vault. When opening the Vault for the first time, take a look to the note [[Welcome to MASB!]] order to get an overview of the course contents and structure. The course is alive and new contents could be added by me, or even you! So, if you want to get last updates, open a Git bash terminal in the repository folder and execute the command:

```bash

git pull

```

# 💬Help and questions

If you are gettings issues with the Vault or have any questions, please, don't hesitate to ask your questions in the [repository's GitHub Discussion](https://github.com/TheAlbertDev/MASB/discussions/categories/q-a).