apadana/arkdep
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Dennis ten Hoove 2024-01-12 10:52:53 +01:00
parent 1e9c9ea4dd
commit 7e23c3c1bc
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -10,13 +10,16 @@ Arkdep attempts to be as simple to use as possible and avoid unnecessary abstrac
Arkdep can be easily rolled out and torn down again, it is non-invasive by design. So it _should_ be safe to just toy around with it on your system. Arkdep can be easily rolled out and torn down again, it is non-invasive by design. So it _should_ be safe to just toy around with it on your system.
System requirements; System requirements for usage;
- `/` is partitioned with btrfs - `/` is partitioned with btrfs
- `/boot` mounted boot partition - `/boot` mounted boot partition
- 512MiB boot partition for max 2 deployments, 1GiB recommended - 512MiB boot partition for max 2 deployments, 1GiB recommended
- Systemd-boot bootloader is installed and configured as the primary bootloader - Systemd-boot bootloader is installed and configured as the primary bootloader
- dracut, wget and curl are installed - dracut, wget and curl are installed
System requirements for image building;
- `arch-install-scripts` are installed
The following command will initialize Arkdep, it will deploy a subvolume containing all Arkdep related files excluding kernels and initramfs to `/arkdep`. Kernel and initramfs will instead be stored in `/boot/arkdep` upon generation. The following command will initialize Arkdep, it will deploy a subvolume containing all Arkdep related files excluding kernels and initramfs to `/arkdep`. Kernel and initramfs will instead be stored in `/boot/arkdep` upon generation.
```shell ```shell
sudo arkdep init sudo arkdep init