feat: updated readme

This commit is contained in:
Nick 2024-06-28 19:59:04 -05:00
parent 407fb9869f
commit b52ae8b76a

View file

@ -1,12 +1,33 @@
# Obsidian Vault Instructions # Obsidian Vault Instructions
## Reproduce the Obsidian vault
#### Option 1: Clone via HTTPS:
- Clone this repo to your PC with **HTTPS**.
- Install [Git](https://git-scm.com/downloads).
- Choose a directory to want the repo to be in.
- Open the terminal and use the command `cd <your-directory>'
- Once in the directory, use the command `git clone https://gitlab.com/BRBWaffles/obsidian.git`
#### Option 2: Download via zip:
- Download this git repo to your PC as a **zip**.
- Near the top of this page, click the **"Code"** button.
- Under **"Download source code"**, select **zip**.
- Once downloaded, unzip the **obsidian-master.zip** file wherever you want.
**Option 1** is preferable to **Option 2**, as you'll be able to `cd` to the vault **root directory** and use the `git pull` terminal command to pull directly from the repo if there are any changes. Using **Option 2** may look easier, but it also means you need to update the vault manually by redownloading the zip file whenever there are changes to the GitLab repo.
## Initialize the Obsidian vault
- Download and install [**Obsidian**](https://obsidian.md/). - Download and install [**Obsidian**](https://obsidian.md/).
- Download this git repo to your PC as a [**zip**](https://gitlab.com/BRBWaffles/obsidian/-/archive/master/obsidian-master.zip).
- Once downloaded, unzip the **obsidian.zip** file wherever you want.
- Open **Obsidian** and select **Open folder** as vault. - Open **Obsidian** and select **Open folder** as vault.
- Navigate to the unzipped vault folder, select it, and click **Select Folder**. - Navigate to the vault folder, select it, and click **Select Folder**.
- Once the vault has loaded into **Obsidian**, click the 🔍 icon. - Once the vault has loaded into **Obsidian**, click the 🔍 icon.
## Navigate the Obsidian vault
Now you're ready to navigate the vault. You can search for any nutrition-related topic you wish. For example, if you want to find information on whole grains, you can search with the hashtag "#whole_grains" or the keyword "whole grains" to find all notes related to whole grains. Now you're ready to navigate the vault. You can search for any nutrition-related topic you wish. For example, if you want to find information on whole grains, you can search with the hashtag "#whole_grains" or the keyword "whole grains" to find all notes related to whole grains.
To learn more about **Obsidian**, you can visit the following links: To learn more about **Obsidian**, you can visit the following links:
@ -15,6 +36,12 @@ To learn more about **Obsidian**, you can visit the following links:
- [Obsidian Discord Server](https://discord.com/invite/veuWUTm) - [Obsidian Discord Server](https://discord.com/invite/veuWUTm)
- [Obsidian Beginner Guide](https://www.youtube.com/watch?v=QgbLb6QCK88) - [Obsidian Beginner Guide](https://www.youtube.com/watch?v=QgbLb6QCK88)
## Support the Obsidian vault
The vault is a work in progress and has taken a great deal of time to build thus far. If you have found this resource useful and wish to support its development, consider pledging to the [Nutrivore Patreon](https://www.patreon.com/thenutrivore)! The vault is a work in progress and has taken a great deal of time to build thus far. If you have found this resource useful and wish to support its development, consider pledging to the [Nutrivore Patreon](https://www.patreon.com/thenutrivore)!
If you wish to contribute to the vault, submit a [Merge Request](https://gitlab.com/BRBWaffles/obsidian/-/merge_requests). If you wish to contribute to the vault, submit a [**Merge Request**](https://gitlab.com/BRBWaffles/obsidian/-/merge_requests). If you do make a **Merge Request**, make sure to add the **.obsidian** folder to your **.gitignore** to avoid unnecessary merge conflicts.
## Follow the Obsidian vault
Lastly, be sure to **star** this repo and click the **bell** for to receive change notifications.