Add QUICKSTART.md
This commit is contained in:
@@ -0,0 +1,52 @@
|
||||
# Quick Start
|
||||
|
||||
## First Time Setup
|
||||
|
||||
1. **Clone the repo:**
|
||||
```bash
|
||||
cd /home/tr/.qwen/projects/
|
||||
git clone https://teashop.invaliddevice.com/bramble/kdb.git memory
|
||||
```
|
||||
|
||||
2. **Open in Obsidian:**
|
||||
```bash
|
||||
obsidian /home/tr/.qwen/projects/-home-tr-work-kdb/memory
|
||||
```
|
||||
|
||||
3. **Or use the helper script:**
|
||||
```bash
|
||||
sflabs-kdb open
|
||||
```
|
||||
|
||||
## Daily Workflow
|
||||
|
||||
```bash
|
||||
# Before starting work - get latest memories
|
||||
sflabs-kdb pull
|
||||
|
||||
# After completing work - share changes
|
||||
git add .
|
||||
git commit -m "Describe changes"
|
||||
sflabs-kdb push
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `sflabs-kdb pull` | Get latest from Gitea |
|
||||
| `sflabs-kdb push` | Push to Gitea |
|
||||
| `sflabs-kdb sync` | Pull + push |
|
||||
| `sflabs-kdb status` | Show git status |
|
||||
| `sflabs-kdb open` | Open in Obsidian |
|
||||
|
||||
## Repository
|
||||
|
||||
- **URL:** https://teashop.invaliddevice.com/bramble/kdb
|
||||
- **Local:** `/home/tr/.qwen/projects/-home-tr-work-kdb/memory`
|
||||
|
||||
## Need Help?
|
||||
|
||||
- Full docs: `SETUP.md`
|
||||
- Skill docs: `/home/tr/.qwen/skills/sflabs-kdb/README.md`
|
||||
- Script help: `sflabs-kdb help`
|
||||
Reference in New Issue
Block a user