Skip to content

Commit 491036d

Browse files
committed
pseudo-install instructions & update todos
1 parent 2d9a8aa commit 491036d

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@ Mind - *tags for the sane*. A NIMble and efficient tag-based system for file and
33

44
With a focus on simplicity, **Mind** allows users to effortlessley exploit the tagging system to create multiple layouts and structures (think quick semantic lookups, or even KANBAN for your terminal). All due to tags and a powerful boolean-based lookup DSL.
55

6+
### Installation
7+
Releasing this as a small package-manager-installable tool is still in the back of my mind but only to be done as soon as I finish with the todo list :point_down:.
8+
For now, unfortunately, you need to go through this insufferable process (sorry again):
9+
- [Install Nim](nim-lang.org/install_unix.html) (which in turn will install its package manager [Nimble](github.com/nim-lang/nimble)) and follow the required steps.
10+
- Clone this project
11+
- Go inside the project directory and run `nimble install --deepcopy:on`
12+
13+
Btw, never tried this on windows, it should work and even if it's not, it's probably for some dumb file path issues that I'll _make sure to debug_ if someone asks me to :eyes:.
14+
615
### Usage example
716
<img src="./assets/screen.png" height="750">
817

@@ -13,13 +22,10 @@ With a focus on simplicity, **Mind** allows users to effortlessley exploit the t
1322
- [x] ~~Add hash/checksums support for duplicates detection~~ (replaced with `dev_t` & `ino_t` checks)
1423
- [x] Synchronise sym links
1524
- [x] Full Lookup DSL
16-
- [ ] Memos support :memo:
17-
- [ ] Tasks and TODO lists :white_check_mark:
18-
- [ ] Key-value store :key: (with optional encryption :lock:)
1925
- [ ] Backups (compression and auto-backups)
26+
- [ ] Clean DSL syntax and better errors
2027
- [ ] Full error-handling + code and usage documentation
21-
- [ ] Optimization time / ORM-less, Cascade deletes? :thinking_face: (maybe SQL-less even)
22-
- [ ] Some CLI visual work (maybe some zsh completions)
28+
- [ ] ORM-less, Cascade deletes? :thinking_face: (maybe SQL-less even)
29+
- [ ] Optimization :running: and debugging time (memory leaks, anyone? + Ensure ARC)
2330
- [ ] Testing :tired_face:
24-
- [ ] Behaviour configuration and defaults
25-
- [ ] AI-backend for multi-modal content auto-tagging
31+
- [ ] Some CLI visual work (maybe some zsh completions)

0 commit comments

Comments
 (0)