chill/bens-obsidian-boilerplate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update instructions

Browse Source
This commit is contained in:
Ben Hong
2021-05-04 15:47:03 -04:00
parent 07cff90581
commit 3b7816e548
2 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,3 +1,14 @@
# obsidian-starter-kit (version alpha-0.1.0)
# Obsidian Starter Kit
An opinionated starter kit to help people get up and running as quickly as possible
An opinionated starter kit to help people get up and running as quickly as possible.
## Getting Up and Running
1. Download and install [Obsidian](https://obsidian.md/)
2. [Download](https://github.com/bencodezen/obsidian-starter-kit/archive/refs/heads/main.zip) or clone a fork of this repo
3. Open Obsidian and you should see a prompt like below:
<img src="/assets/obsidian-prompt.png" alt="Obsidian open prompt" width="300" />
4. Click on the `Open` button next to "Open folder as vault"
5. Select the folder you've downloaded / cloned from Step #2.

BIN
assets/obsidian-prompt.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 104 KiB