Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Setting and how to get started #45

Merged
merged 3 commits into from
Nov 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,28 @@ Hello, fellow learners and knowledge seekers! 📚 If you're as passionate about

**Embark on a Motivational Journey!**

### Additional config informations

In some cases the same vault is used vor other activities as well an the knowledge management shall stay separated. Then you can exclude #tags and/or folders, which shall not be used when initialized. By default the folder 'Excalidraw' is entered. You can ignore this setting if you want to use all files in you vault for you pkm.
![Settings for exclude TAGs and folders](/docs/images/SettingsExcludeTagsFolders.png)

## Getting Started

### initialise game

When not already done during installation, hit `CTRL+P` and run command `Initialize gamification ratings`. This command will create you profile, rate you existing notes and give you a starting level. On the profile you can get informations to you current level, points, badges and see the distribution of you note maturitys.

![Gamification Initialization Command](/docs/images/GamificationInitializationCommand.png)

### next steps

create a new note and use the plant-icon on the side or `CTRL+P` and ran command `Rate note maturity`.
![Rate Note First Time](/docs/images/RateNoteFirstTime.png)

work on an existing note, improve you thougts, you title, link it to other fitting notes and run `CTRL+P` and ran command `Rate note maturity`, or use the plant-icon.
![Rate again after improving](/docs/images/RateAfterImprovement.png)


## Hey there! 👋
Imagine transforming your knowledge management into an adventure where every step forward is a celebration. Introducing the Obsidian Gamification Plugin – a tool designed to harness the motivating power of game techniques and apply it to our pursuit of knowledge.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/RateAfterImprovement.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/RateNoteFirstTime.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/SettingsExcludeTagsFolders.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.