zincplusplus / habit-tracker

GNU General Public License v3.0
50 stars 6 forks source link

Improve README - Instructions to setup the plugin #31

Open Alves-Bruno opened 6 months ago

Alves-Bruno commented 6 months ago

This looks like a very nice plugin. However, I could not setup and use the plugin based on the instructions found on the README. Can you please provide detailed instructions on how to add the days for each habit?

So far, I have done the following:

Also, I recentely started using the Obsidian.

holroy commented 6 months ago

Could you please show the code block you've created?

To add days you simply click on the date in tracker table, and it should show a different color tick bar for each day you've completed as shown in the example at the bottom of the Readme.md file.

Crowbrammer commented 2 months ago

I'm also having issues.

Here's my code block:

{ "path": "Habits", }

I've also tried

habittracker { 
     "path": "Habits/" 
}

from the readme. Here's my debug info:


SYSTEM INFO:
    Obsidian version: v1.6.7
    Installer version: v1.4.13
    Operating system: Windows 10 Home 10.0.22631
    Login status: logged in
    Catalyst license: none
    Insider build toggle: off
    Live preview: on
    Base theme: dark
    Community theme: none
    Snippets enabled: 0
    Restricted mode: off
    Plugins installed: 5
    Plugins enabled: 5
        1: Excalidraw v2.3.0
        2: Hotkeys for specific files v1.4.1
        3: Kanban v2.0.51
        4: Recent Files v1.4.1
        5: Habit Tracker 21 v1.4.4

RECOMMENDATIONS:
    Community plugins: for bugs, please first try updating all your plugins to latest. If still not fixed, please try to make the issue happen in the 
```Sandbox Vault or disable community plugins.
\
divin commented 2 months ago

@Alves-Bruno and @Crowbrammer, you may already have this working, but these are the basic steps to make it work:

  1. Install the plugin
  2. Activate the plugin
  3. Create a folder for your habits, it can be any name but let's say it's Habits.
  4. Create your habits in this folder, e.g. Habits/Habit1.md, Habits/Habit2.md, ..., these are just empty markdown files, the name of the file is the habit name.
  5. On the same level as the Habits folder create a new file like Habits.md and copy/paste the code block
    ```habittracker
    { 
    "path": "Habits/" 
    }
  6. Switch to "Reading View" (⌘ + E on MacOS).
  7. You should now be able to simply click on the days to add your habit entries.

Hope this helps 😄

Crowbrammer commented 2 months ago

@divin, here's what I see

Am I missing something? (I'm on Windows)

divin commented 2 months ago

Hi @Crowbrammer, sorry Markdown just formatted by my answer not as intended I just edited my answer.

  1. What you are missing is the habittracker next to the first `` in yourHabit viewer.md` file.
  2. You need to move the Habit viewer.md file out of the Habits folder, it has to be on the same level (e.g. Habit viewer.md is not in the Habits folder).

Let me know if you still run into issues 😄

Crowbrammer commented 1 month ago

@divin, thank you SO much for getting back to me so promptly, and I'm VERY sorry I didn't get back to you earlier.

What you said absolutely worked, ALSO I had to add some space beneath the thing. Again, thank you very much <3