You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-3Lines changed: 16 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,26 @@
2
2
3
3
A gamified framework for tracking projects (quests) and inventory.
4
4
5
-
Check the `Tutorial` folder for guidance:
5
+
## Install
6
+
7
+
The only pre-requisite is [Obsidian](https://obsidian.md/download).
8
+
9
+
There are two options:
10
+
- For the latest stable release, head over to [Releases](https://github.com/Fabulani/nexus/releases). Download the source code either in `.zip` or `.tar.gz` format.
11
+
- For the unstable release, where I'm pushing updates before the next stable release, click on the `< > Code` button and either clone the repo or download the ZIP.
12
+
13
+
After downloading the files:
14
+
1. Extract contents into a folder.
15
+
2. Open Obsidian.
16
+
3. Go to `Manage vaults...` > `Open folder as vault` and select the extracted folder.
17
+
18
+
Select `Trust author and enable plugins` for the full experience, or `Browse vault in Restricted Mode` to check it out without all the plugins. Always be careful when enabling plugins from third-parties!
19
+
20
+
And that's it! Check the `Tutorial` folder for further guidance:
6
21
-[Usage](./Tutorial/Usage.md)
7
22
-[Settings](./Tutorial/Settings.md)
8
23
-[Implementation](./Tutorial/Implementation.md)
9
24
10
-
This repository contains example `.md` files for the framework, as well as plugin settings for the necessary plugins. Plugin versions used can be checked in their manifest file inside `.obsidian/plugins/**/manifest.json`.
0 commit comments