Skip to content

Commit 4ca27f5

Browse files
danupsherclaude
andcommitted
Build 91: README rebrand + remove Ollama from base
- Complete README overhaul with clean, professional copy - Removed Ollama from build to save space (available via jumpdev install-ollama) - Updated jumpdev doctor to treat Ollama as optional Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 596fe32 commit 4ca27f5

3 files changed

Lines changed: 50 additions & 267 deletions

File tree

README.md

Lines changed: 47 additions & 262 deletions
Original file line numberDiff line numberDiff line change
@@ -1,305 +1,90 @@
11
# JumpDev OS
22

3-
[![Build ISO](https://github.com/danupsher/jumpdev-os/actions/workflows/build-iso.yml/badge.svg)](https://github.com/danupsher/jumpdev-os/actions/workflows/build-iso.yml)
4-
5-
**Your dev environment, on a USB stick.**
6-
7-
A portable Linux distribution for modern development. Boot from USB on any PC, get a fully configured workspace with AI coding tools, and migrate to disk when you're ready.
8-
9-
---
10-
11-
## Why JumpDev OS?
12-
13-
**The Problem**: Setting up a dev environment takes hours. Doing it on multiple machines takes days. Cloud solutions need internet. VMs are slow.
14-
15-
**The Solution**: JumpDev OS. Plug in a USB, boot up, start coding. Same tools, same configs, same projects - on any PC.
3+
A portable Linux development environment with AI coding tools pre-installed. Runs from USB on any x86_64 machine.
164

175
---
186

19-
## Features
20-
21-
### Portable Development
22-
- Boot from USB on any x86_64 PC
23-
- Your environment travels with you
24-
- Files and logins persist between reboots
25-
- Works offline - no cloud dependency
26-
27-
### AI-Powered Coding
28-
- **Claude Code** - AI pair programming in your terminal
29-
- **Aider** - Git-aware AI coding assistant
30-
- **Ollama** - Run local LLMs offline
31-
- Ready to vibe code out of the box
32-
33-
### Modern Desktop
34-
- **Hyprland** - Tiling window manager with smooth animations
35-
- **Window title bars** - Close, maximize, minimize buttons on every window
36-
- **nwg-menu** - Traditional app menu (like Windows Start menu)
37-
- **Waybar** - Status bar with quick-launch buttons
38-
- **Catppuccin Mocha** - Easy-on-the-eyes dark theme
39-
40-
### Development Stack
41-
- **Editors**: Neovim (LSP pre-configured), VS Code available via first-boot
42-
- **Version Control**: Git, GitHub CLI, Lazygit
43-
- **Containers**: Docker, Docker Compose, Lazydocker
44-
- **Languages**: Node.js, Python, Rust (rustup) + mise version manager
45-
- **CLI Tools**: fzf, ripgrep, fd, bat, eza, zoxide, yazi, btop, tmux, zellij
46-
47-
### Portable → Permanent
48-
Use JumpDev OS from USB for a day, a week, or a month. When you're ready to install permanently:
49-
50-
1. Click "Install to Disk"
51-
2. Partition your drive (erase, dual-boot, or manual)
52-
3. Everything migrates automatically:
53-
- Browser sessions and logins
54-
- App data and configurations
55-
- Projects and files
56-
- Installed packages
57-
58-
Same environment. Same logins. Just faster.
59-
60-
---
61-
62-
## Screenshots
63-
64-
*Coming soon*
7+
## What is JumpDev OS?
658

66-
---
67-
68-
## Quick Start
9+
A complete development environment that runs from a USB drive. Claude Code and a modern desktop, ready to go. No installation. No configuration.
6910

70-
1. **Download** the latest ISO from [Releases](https://github.com/danupsher/jumpdev-os/releases)
71-
2. **Flash** to USB with [Balena Etcher](https://etcher.balena.io/) or [Rufus](https://rufus.ie/)
72-
3. **Boot** from USB (disable Secure Boot if needed)
73-
4. **Code** - everything's ready
11+
Equipped for serious development. Great for developers leveraging AI or vibecoders building their first project.
7412

7513
---
7614

77-
## Requirements
15+
## Why JumpDev?
7816

79-
| Component | Minimum | Recommended |
80-
|-----------|---------|-------------|
81-
| USB Drive | 16GB USB 3.0 | 32GB+ USB 3.0/3.1 |
82-
| RAM | 8GB | 16GB |
83-
| CPU | x86_64 | - |
84-
| Boot | UEFI or Legacy BIOS | UEFI |
17+
### Clean & Focused
18+
No bloat. A modern Hyprland desktop with what you need to code.
8519

86-
**Note**: Secure Boot must be disabled.
20+
### Portable
21+
Runs from USB on any PC. Your environment stays consistent across machines. Install to disk anytime to make it permanent.
8722

88-
**USB Recommendations**:
89-
| Tier | Example | Boot Time |
90-
|------|---------|-----------|
91-
| Good | Any USB 3.0 | ~60s |
92-
| Better | SanDisk Extreme Pro | ~30s |
93-
| Best | Samsung T7 SSD | ~15s |
23+
### Persistent
24+
Optional persistence saves files and settings between reboots.
9425

9526
---
9627

97-
## What's Included
98-
99-
### Desktop Environment
100-
| Component | Description |
101-
|-----------|-------------|
102-
| Hyprland | Tiling Wayland compositor |
103-
| Waybar | Status bar with quick-launch buttons |
104-
| nwg-menu | Traditional app menu (like Windows Start) |
105-
| Mako | Notification daemon |
106-
| wlogout | Logout/power menu |
107-
108-
### Editors
109-
| Editor | Description |
110-
|--------|-------------|
111-
| Neovim | Terminal editor with LSP, Treesitter, Telescope |
112-
| VS Code | Available via first-boot app selector |
113-
114-
### AI & Coding Tools
115-
| Tool | Description |
116-
|------|-------------|
117-
| Claude Code | AI pair programming |
118-
| Aider | Git-aware AI assistant |
119-
| Ollama | Local LLM runner |
120-
| GitHub CLI | GitHub from the terminal |
121-
| Lazygit | Terminal UI for Git |
122-
123-
### Languages & Runtimes
124-
| Language | Version |
125-
|----------|---------|
126-
| Node.js | Latest LTS |
127-
| Python | 3.x with pip/pipx |
128-
| Rust | Via rustup |
129-
130-
### Containers
131-
| Tool | Description |
132-
|------|-------------|
133-
| Docker | Container runtime |
134-
| Docker Compose | Multi-container apps |
135-
| Docker Buildx | Extended build features |
136-
| Lazydocker | Docker TUI |
137-
138-
### Applications
139-
| App | Description |
140-
|-----|-------------|
141-
| Firefox | Web browser |
142-
| Thunar | File manager |
143-
| mpv | Media player |
144-
| imv | Image viewer |
145-
| pavucontrol | Audio settings |
146-
| blueman | Bluetooth manager |
147-
148-
### First-Boot App Selector (Optional)
149-
| App | Description |
150-
|-----|-------------|
151-
| VS Code | Full GUI editor |
152-
| Google Chrome | Browser |
153-
| Discord | Communication |
154-
| NVIDIA Drivers | For NVIDIA GPUs |
155-
156-
### CLI Tools
157-
```
158-
fzf - Fuzzy finder
159-
ripgrep - Fast search
160-
fd - Fast find
161-
bat - Better cat
162-
eza - Better ls
163-
zoxide - Smart cd
164-
yazi - Terminal file manager
165-
btop - System monitor
166-
jq/yq - JSON/YAML tools
167-
tmux - Terminal multiplexer
168-
zellij - Modern terminal multiplexer
169-
mise - Version manager (node/python/ruby)
170-
fastfetch - System info
171-
```
172-
173-
---
174-
175-
## Keyboard Shortcuts
176-
177-
| Key | Action |
178-
|-----|--------|
179-
| `Super + Return` | Terminal (Kitty) |
180-
| `Super + D` | App menu |
181-
| `Super + Q` | Close window |
182-
| `Super + B` | Firefox |
183-
| `Super + E` | File manager |
184-
| `Super + F` | Fullscreen |
185-
| `Super + 1-9` | Switch workspace |
186-
| `Print` | Screenshot |
187-
188-
---
189-
190-
## Hardware Support
191-
192-
### Graphics
193-
| Vendor | Driver | Status |
194-
|--------|--------|--------|
195-
| Intel | mesa, vulkan-intel | Full support |
196-
| AMD | mesa, vulkan-radeon | Full support |
197-
| NVIDIA | nvidia-open-dkms | Via first-boot selector |
198-
199-
### WiFi
200-
Drivers included for: Intel, Atheros, Broadcom, Realtek, Marvell, MediaTek, Ralink
201-
202-
Most laptops work out of the box.
203-
204-
### Audio
205-
PipeWire with PulseAudio and JACK compatibility.
28+
## Features
20629

207-
---
30+
### AI-Assisted Development
31+
- **Claude Code** — Anthropic's AI coding assistant
20832

209-
## Tech Stack
33+
### Desktop
34+
- Hyprland with Catppuccin Mocha theme
35+
- Keyboard and mouse friendly
21036

211-
| Component | Choice |
212-
|-----------|--------|
213-
| Base | Arch Linux |
214-
| Kernel | linux-zen |
215-
| Display | Wayland |
216-
| Compositor | Hyprland |
217-
| Terminal | Kitty |
218-
| Shell | Zsh + Starship |
219-
| Theme | Catppuccin Mocha |
220-
| Font | JetBrains Mono Nerd Font |
37+
### Tools
38+
- Docker, Git, Neovim, Tmux
39+
- Firefox
40+
- Standard development utilities
22141

22242
---
22343

224-
## Roadmap
44+
## Quick Start
22545

226-
- [x] Gate 1: Bootable ISO with Hyprland desktop
227-
- [x] Gate 2: Apps, dev tools, and polished UI
228-
- [ ] Gate 3: Persistence (files/logins saved between reboots)
229-
- [ ] Gate 3.5: Install to disk with seamless migration
230-
- [ ] Gate 4: Polish, branding, and v1.0 release
231-
- [ ] Gate 5: ARM64 / Apple Silicon support
46+
1. **Download** the latest ISO from [Releases](https://github.com/danupsher/jumpdev-os/releases)
47+
2. **Flash** to a USB drive using Ventoy, Rufus, or Etcher
48+
3. **Boot** from USB
49+
4. **Code** — open a terminal and type `claude`
23250

23351
---
23452

235-
## Building from Source
236-
237-
Requires Arch Linux (VM or container):
53+
## Commands
23854

23955
```bash
240-
# Clone
241-
git clone https://github.com/danupsher/jumpdev-os.git
242-
cd jumpdev-os
243-
244-
# Install archiso
245-
sudo pacman -S archiso
246-
247-
# Build
248-
sudo mkarchiso -v -w /tmp/archiso-work -o out/ archiso/
56+
jumpdev help # Show all commands
57+
jumpdev setup # Run first-time setup
58+
jumpdev set-api-key # Configure your Anthropic API key
59+
jumpdev doctor # Check system health
24960
```
25061

251-
Or just push to `main` - GitHub Actions builds the ISO automatically.
252-
25362
---
25463

255-
## Project Structure
64+
## Requirements
25665

257-
```
258-
jumpdev-os/
259-
├── archiso/ # Archiso build configuration
260-
│ ├── airootfs/ # Files copied to live system
261-
│ ├── packages.x86_64 # Package list
262-
│ └── profiledef.sh # Build profile
263-
├── configs/ # Application configs
264-
│ ├── hypr/ # Hyprland
265-
│ ├── waybar/ # Status bar
266-
│ ├── nvim/ # Neovim
267-
│ └── ...
268-
└── .github/workflows/ # CI/CD
269-
```
66+
- **USB drive**: 16GB+ recommended, USB 3.0 or faster
67+
- **Machine**: x86_64 PC with USB boot support
68+
- **API key**: Anthropic API key for Claude Code (console.anthropic.com)
27069

27170
---
27271

273-
## Contributing
72+
## Status
27473

275-
Contributions welcome! Read these first:
276-
277-
- `CLAUDE.md` - Guide for AI-assisted development sessions
278-
- `COMPREHENSIVE_PLAN.md` - Full project roadmap and gates
279-
- `DECISIONS.md` - Architectural decisions and rationale
280-
- `BUILD_LOG.md` - Build history and known issues
281-
282-
---
74+
In active development.
28375

284-
## License
76+
- [x] Bootable live environment
77+
- [x] Claude Code pre-installed
78+
- [x] Modern desktop
79+
- [x] First-boot setup wizard
80+
- [ ] Persistence on real hardware
81+
- [ ] Install-to-disk option
28582

286-
MIT License - see [LICENSE](LICENSE)
83+
### Roadmap
84+
- ARM64 support
28785

28886
---
28987

290-
## Acknowledgements
291-
292-
Built on the shoulders of giants:
293-
294-
- [Arch Linux](https://archlinux.org/) & [Archiso](https://wiki.archlinux.org/title/Archiso)
295-
- [Hyprland](https://hyprland.org/) & [hyprland-plugins](https://github.com/hyprwm/hyprland-plugins)
296-
- [Catppuccin](https://github.com/catppuccin/catppuccin)
297-
- [Chaotic-AUR](https://aur.chaotic.cx/)
298-
- [Neovim](https://neovim.io/)
299-
300-
---
88+
## License
30189

302-
<p align="center">
303-
<strong>Your dev environment, on a USB stick.</strong><br>
304-
Plug in. Boot up. Code.
305-
</p>
90+
MIT

archiso/airootfs/root/customize_airootfs.sh

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ npm install -g @anthropic-ai/claude-code || echo "Claude Code install failed, wi
1717
# Aider requires persistence (too large for live tmpfs)
1818
# Users can install via: jumpdev install-aider (after setting up persistence)
1919

20-
# Install Ollama
21-
echo "Installing Ollama..."
22-
curl -fsSL https://ollama.com/install.sh | sh || echo "Ollama install failed, will retry on first boot"
20+
# Ollama available via: jumpdev install-ollama (optional, large download)
2321

2422
# Initialize rustup for the jump user's skel
2523
echo "Initializing Rust toolchain..."

archiso/airootfs/usr/local/bin/jumpdev

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ cmd_help() {
4747
echo ""
4848
echo -e "${YELLOW}AI Tools${NC}"
4949
echo " install-aider Install Aider (requires persistence)"
50-
echo " install-ollama Reinstall/update Ollama"
50+
echo " install-ollama Install Ollama for local models"
5151
echo " install-claude Reinstall/update Claude Code"
5252
echo ""
5353
echo -e "${YELLOW}System${NC}"
@@ -213,7 +213,7 @@ cmd_doctor() {
213213
# Check key commands
214214
echo "AI Tools:"
215215
command -v claude &>/dev/null && print_success "Claude Code" || print_error "Claude Code not found"
216-
command -v ollama &>/dev/null && print_success "Ollama" || print_error "Ollama not found"
216+
command -v ollama &>/dev/null && print_success "Ollama" || print_warn "Ollama not installed (run: jumpdev install-ollama)"
217217
command -v aider &>/dev/null && print_success "Aider" || print_warn "Aider not installed (run: jumpdev install-aider)"
218218
echo ""
219219

0 commit comments

Comments
 (0)