Installation

.md
shcurl -LsSf https://astral.sh/uv/install.sh | sh

uv manages Python and the dependencies. Install it once, then clone.

macOS · linux
curl -LsSf https://astral.sh/uv/install.sh | sh
windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
clone
git clone https://github.com/GustavoPenaBeltrami/self-learning-platform.git
cd self-learning-platform
uv run slp
requires
python ≥ 3.9, fetched by uv
deps
mlx-whisper on Apple Silicon, faster-whisper elsewhere. Only dictation uses them
keep your topics
git remote set-url origin <your-repo>

// want dictation ready offline? run uv run slp setup right after cloning

Recommended setup

Your material, the app and the agent side by side. Two monitors help.

layout
┌──────────┬──────────┬──────────┐
│ material │   app    │  agent   │
│  pdf     │  notes   │  /slp-*  │
│  course  │  exams   │          │
│          │  cards   │          │
└──────────┴──────────┴──────────┘
1 · material
the PDF, the course, the docs. Whatever you're studying
2 · app
uv run slp in the browser: notes, cards, exams, exercises, settings
3 · agent
open at the repo root. Teaches, builds exams, grades

Next: getting started.

Markdown formats

The documentation is also available in llms.txt formats:

  • llms.txt lists every documentation page.
  • llms-full.txt contains the complete documentation in one file and may exceed some context windows.

Append .md to any documentation URL to retrieve that page as Markdown. For example, this page is available at https://selflearningplatform.github.io/docs/install.md. You can also copy the current page as Markdown by pressing Cmd+C or Ctrl+C.