feat: add comprehensive notes field to arty.yml
Adds detailed project documentation in the notes field including: - Project overview and quick start guide - Key features and development tools - Important commands and best practices - Repository links and documentation The notes can be displayed using 'arty notes' command with beautiful markdown rendering. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
48
arty.yml
48
arty.yml
@@ -4,6 +4,51 @@ description: "Valknar's home repository"
|
|||||||
author: "valknar@pivoine.art"
|
author: "valknar@pivoine.art"
|
||||||
license: "MIT"
|
license: "MIT"
|
||||||
|
|
||||||
|
notes: |
|
||||||
|
# Valknar's Home Repository
|
||||||
|
|
||||||
|
This is a **personal development environment** configuration managed with `arty`.
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install all dependencies
|
||||||
|
arty deps
|
||||||
|
|
||||||
|
# Update system packages
|
||||||
|
arty debian/update && arty debian/install
|
||||||
|
|
||||||
|
# Install development tools
|
||||||
|
arty node/install
|
||||||
|
arty rust/install
|
||||||
|
arty python/install
|
||||||
|
```
|
||||||
|
|
||||||
|
## Key Features
|
||||||
|
|
||||||
|
- **Shell Configuration**: Zsh with Oh-My-Zsh and Powerlevel10k theme
|
||||||
|
- **Version Managers**: nvm (Node), rbenv (Ruby), pyenv (Python), gvm (Go)
|
||||||
|
- **Development Tools**: Docker, Rust, Node.js, Python, Ruby
|
||||||
|
- **Utilities**: Custom scripts in `bin/` directory
|
||||||
|
|
||||||
|
## Important Commands
|
||||||
|
|
||||||
|
1. **System Setup** - Run Ansible playbook for complete setup
|
||||||
|
2. **Environment Variables** - Loaded from `.init/export.sh`
|
||||||
|
3. **Custom Functions** - Available in `.init/functions.sh`
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
|
- [Repository](ssh://git@dev.pivoine.art:2222/valknar/bin.git)
|
||||||
|
- [Documentation](https://docs.pivoine.art)
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Always use `arty` to manage Docker containers
|
||||||
|
- Run `arty up -d CONTAINER` instead of `arty restart CONTAINER`
|
||||||
|
- Push with the `valknarthing` SSH key
|
||||||
|
- Ensure SSH agent has only one key for pushing
|
||||||
|
|
||||||
references:
|
references:
|
||||||
- url: git@github.com:valknarogg/bin.git
|
- url: git@github.com:valknarogg/bin.git
|
||||||
into: bin
|
into: bin
|
||||||
@@ -30,8 +75,9 @@ scripts:
|
|||||||
debian/update: sudo sed -i 's/main non-free-firmware/main contrib non-free non-free-firmware/g' /etc/apt/sources.list && sudo apt update
|
debian/update: sudo sed -i 's/main non-free-firmware/main contrib non-free non-free-firmware/g' /etc/apt/sources.list && sudo apt update
|
||||||
debian/install:
|
debian/install:
|
||||||
sudo apt install curl zsh fzf davfs2 krusader make imagemagick ffmpeg yt-dlp
|
sudo apt install curl zsh fzf davfs2 krusader make imagemagick ffmpeg yt-dlp
|
||||||
thunderbird pkg-config blueman libffi-dev zlib1g-dev libyaml-dev libssl-dev tree audacity
|
thunderbird pkg-config blueman libffi-dev zlib1g-dev libyaml-dev libssl-dev tree firmware-linux-nonfree firmware-realtek
|
||||||
debian/remove: sudo apt remove pulseaudio-module-bluetooth
|
debian/remove: sudo apt remove pulseaudio-module-bluetooth
|
||||||
|
docker/install: curl -fsSL -o- https://get.docker.com | sudo sh && sudo usermod -aG docker $USER
|
||||||
rust/install: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
rust/install: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||||
node/install: nvm install
|
node/install: nvm install
|
||||||
ruby/install: rbenv install
|
ruby/install: rbenv install
|
||||||
|
|||||||
Reference in New Issue
Block a user