Skip to content

Commit 801a398

Browse files
authored
Merge pull request #22 from arushii09/docs-install-improvements
Docs: improve installation instructions
2 parents 44b8f27 + ca56d08 commit 801a398

1 file changed

Lines changed: 96 additions & 22 deletions

File tree

‎README.md‎

Lines changed: 96 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,94 @@ CodeVerse Linux (CVH Linux) is a **community-driven, Arch-based Linux distributi
88
- **Recommended for:** VM testing while the project is evolving
99
- **Also intended for:** real hardware (use caution; the installer wipes the selected disk)
1010

11-
## Install (from a built ISO)
12-
13-
1. Build the ISO (see [docs/BUILD.md](docs/BUILD.md)).
14-
2. Write the ISO to USB (or attach it to your VM) and boot it.
15-
3. In the live environment, run the installer:
16-
- `sudo cvh-install`
17-
18-
The installer is interactive and will partition/format the chosen disk.
19-
20-
## Build ISO (quick)
21-
22-
On an Arch-based build host:
23-
24-
- `./scripts/build-iso.sh`
25-
26-
Outputs land in `out/` by default. Full details: [docs/BUILD.md](docs/BUILD.md).
11+
## Getting Started (Beginner-Friendly)
12+
13+
This section walks you through everything from scratch. No prior Arch Linux or ISO experience needed.
14+
15+
### What is an ISO?
16+
17+
An ISO file is a complete, bootable disk image — think of it as a virtual CD/USB that contains a live operating system. To use CVH Linux, you first need to *build* this ISO file from the source code in this repo, then either:
18+
- Flash it to a USB drive and boot your computer from it, **or**
19+
- Attach it to a Virtual Machine (VM) like VirtualBox or QEMU
20+
21+
### Step 1: Set Up Your Build Machine
22+
23+
> **What this means:** You need an existing Arch-based Linux system (like Arch Linux, EndeavourOS, or Manjaro) to build the ISO. Building the ISO is currently supported only on Arch-based systems.
24+
25+
If you don’t have an Arch-based system, you can use a virtual machine (VM) with Arch Linux for building.
26+
27+
Make sure the following tools are installed on your build machine:
28+
29+
```bash
30+
sudo pacman -S archiso git
31+
```
32+
33+
### Step 2: Clone This Repository
34+
35+
```bash
36+
git clone https://github.com/TheCodeVerseHub/CodeVerseLinuxDistro.git
37+
cd CodeVerseLinuxDistro
38+
```
39+
40+
### Step 3: Build the ISO
41+
42+
Run the build script:
43+
```bash
44+
./scripts/build-iso.sh
45+
```
46+
47+
This will take several minutes — it downloads packages and assembles the full system image. When it finishes, you'll find the `.iso` file inside the `out/` folder.
48+
49+
> For more detailed build options and troubleshooting, see [docs/BUILD.md](docs/BUILD.md).
50+
51+
### Step 4: Boot the ISO
52+
This will start a live system that runs directly from the ISO without installing anything.
53+
You have two options depending on whether you're using a real machine or a VM.
54+
55+
#### Option A: Real Hardware (USB Drive)
56+
57+
> **Warning:** The installer will wipe the disk you select. Back up any important data first.
58+
59+
Flash the ISO to a USB drive. Replace `/dev/sdX` with your actual USB device (use `lsblk` to find it):
60+
61+
```bash
62+
sudo dd if=out/codeverse-linux-*.iso of=/dev/sdX bs=4M status=progress oflag=sync
63+
```
64+
65+
Then plug the USB into your target machine and boot from it (usually by pressing F2, F12, or Del during startup to open the boot menu).
66+
67+
#### Option B: Virtual Machine — VirtualBox
68+
69+
1. Open VirtualBox and click **New**
70+
2. Set type to **Linux**, version to **Arch Linux (64-bit)**
71+
3. Allocate at least **2 GB RAM** and **20 GB disk space**
72+
4. Under **Settings → Storage**, attach the `.iso` file as an optical drive
73+
5. Start the VM — it will boot directly into the CVH Linux live environment
74+
75+
#### Option C: Virtual Machine — QEMU
76+
77+
```bash
78+
qemu-system-x86_64 \
79+
-m 2G \
80+
-cdrom out/codeverse-linux-*.iso \
81+
-boot d \
82+
-enable-kvm
83+
```
84+
85+
> Remove `-enable-kvm` if your system doesn't support KVM (you'll see an error if so).
86+
87+
### Step 5: Run the Installer
88+
89+
Once booted into the live environment, open a terminal and run:
90+
91+
```bash
92+
sudo cvh-install
93+
```
94+
95+
The installer is interactive — it will ask you which disk to install to and walk you through the setup. Follow the on-screen prompts.
96+
97+
>**Reminder:** The installer will partition and format the disk you choose. Make sure you select the correct one.
98+
2799

28100
## Screenshots
29101

@@ -36,12 +108,14 @@ Add screenshots to this section as the UI stabilizes.
36108

37109
See [CONTRIBUTING.md](CONTRIBUTING.md) for environment setup, testing, and PR guidelines.
38110

39-
## Repo layout (high level)
40-
41-
- `iso/`: ArchISO profile (packages list, `airootfs/`, bootloader config)
42-
- `scripts/`: build ISO, build packages, legacy/standalone installer script
43-
- `configs/`: GRUB theme + user setup configs (niri, waybar, rofi, etc.)
44-
- `src/` + `pkgbuild/` + `repo/`: custom packages and local pacman repo artifacts
111+
## Repo Layout (High Level)
112+
113+
| Path | Description |
114+
|---|---|
115+
| `iso/` | ArchISO profile (packages list, `airootfs/`, bootloader config) |
116+
| `scripts/` | Build ISO, build packages, legacy/standalone installer script |
117+
| `configs/` | GRUB theme + user setup configs (niri, waybar, rofi, etc.) |
118+
| `src/` + `pkgbuild/` + `repo/` | Custom packages and local pacman repo artifacts |
45119

46120
## License
47121

0 commit comments

Comments
 (0)