fixed link issues with README.md

This commit is contained in:
2025-10-21 14:34:08 -04:00
parent 210d349ea3
commit c026d6a293

View File

@@ -3,16 +3,16 @@ Version: Milestone-1
## Setup
This will create and setup a `SQLite` database if `mind.db` doesn't
exist under [`backend/`](`backend/`).
exist under [`backend/`](backend/).
Also see [`backend/README.md`](`backend/README.md`).
Also see [`backend/README.md`](`backend/README.md).
### Getting a llama.cpp instance
`llama.cpp` is included as a third-party git submodule under
[`third_party`](`third_party/`).
[`third_party`](third_party/).
A script for grabbing a Qwen 3 1.7B LLM model from HuggingFace is at
[`backend/get-qwen3-1.7b.sh`](`backend/get-qwen3-1.7b.sh`).
[`backend/get-qwen3-1.7b.sh`](backend/get-qwen3-1.7b.sh).
The default location for the `Go` layer of the backend to access the LLM
service is `localhost:8081`.
@@ -26,23 +26,23 @@ Run `go run ./backend/main.go`, which will start a backend instance at
Note that if `mind.db` doesn't exist in the working directory, it will
be created and be initialized by the code in
[`backend/db/migrations`](`backend/db/migrations`).
[`backend/db/migrations`](backend/db/migrations).
### DB-related
All db-related operations (e.g. queries) are under
[`backend/db`](`backend/db`).
[`backend/db`](backend/db).
## Running tests
To run tests, we provide a simple CLI-based frontend client at
[`backend/cli.py`](`backend/cli.py`).
[`backend/cli.py`](backend/cli.py).
This will include all of the features supported or under development.
## Current features (and features under development)
A short video demo of basic functionality on the CLI can be found
under [`milestone-1/demo.mp4`](`milestone-1/demo.mp4`).
under [`milestone-1/demo.mp4`](milestone-1/demo.mp4).
The specific APIs used are given in [`backend/design.md`](`backend/design.md`).
The specific APIs used are given in [`backend/design.md`](backend/design.md).
| Action | Command / Description |
|-----------------------------------|------------------------------------------------------------------------------|