Add main project README with overview and quick start guide
This commit is contained in:
parent
583214c8e7
commit
12fd3d6175
1 changed files with 69 additions and 0 deletions
69
README.md
Normal file
69
README.md
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
# Debian Atomic Desktop Project
|
||||
|
||||
A project to create a Debian-based atomic desktop system using `bootc` and `OSTree`, inspired by `ublue-os`.
|
||||
|
||||
## Project Structure
|
||||
|
||||
This project is organized into phases:
|
||||
|
||||
### Phase 1: `01-debian-atomic/`
|
||||
- **Goal**: Create a minimal, bootable Debian Trixie atomic image
|
||||
- **Status**: ✅ Complete
|
||||
- **Contents**:
|
||||
- `Containerfile` - Defines the base atomic image
|
||||
- `justfile` - Build automation
|
||||
- `README.md` - Phase 1 documentation
|
||||
|
||||
### Phase 2: `02-installer/`
|
||||
- **Goal**: Create a bootable ISO with Calamares installer
|
||||
- **Status**: 🔄 In Progress (Contents file issues being resolved)
|
||||
- **Contents**:
|
||||
- `justfile` - Live-build automation
|
||||
- `calamares/` - Installer configuration
|
||||
- `config/` - Live-build configuration
|
||||
- `scripts/` - Helper scripts
|
||||
|
||||
### Phase 2 Alternative: `02-installer-bootc/`
|
||||
- **Goal**: Alternative approach using container-based VM testing
|
||||
- **Status**: 🔄 In Progress
|
||||
- **Contents**:
|
||||
- `Containerfile` - VM container definition
|
||||
- `justfile` - Container build automation
|
||||
- `scripts/` - Testing scripts
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. **Phase 1** (Atomic Image):
|
||||
```bash
|
||||
cd 01-debian-atomic
|
||||
just build-image
|
||||
just test-image
|
||||
```
|
||||
|
||||
2. **Phase 2** (Installer ISO):
|
||||
```bash
|
||||
cd 02-installer
|
||||
just build-iso
|
||||
```
|
||||
|
||||
3. **Phase 2 Alternative** (Container VM):
|
||||
```bash
|
||||
cd 02-installer-bootc
|
||||
just build-container
|
||||
just test-container
|
||||
```
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- `just` command runner
|
||||
- `podman` or `docker`
|
||||
- `live-build` (for Phase 2)
|
||||
- `qemu-system-x86_64` (for testing)
|
||||
|
||||
## Development
|
||||
|
||||
See `roadmap.md` for detailed project planning and `todo` for current tasks.
|
||||
|
||||
## License
|
||||
|
||||
This project is open source. See individual files for specific licensing information.
|
||||
Loading…
Add table
Add a link
Reference in a new issue