docs: replace readme with cliff notes and links to full docs
Old readme archived as readme.md.old. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>main
parent
be3352897c
commit
2b282a1565
81
readme.md
81
readme.md
|
|
@ -1,47 +1,48 @@
|
|||
# Dotfiles
|
||||
# M-Archy Dotfiles
|
||||
|
||||
config for using arch linux in network administration, development and gaming
|
||||
Arch Linux · Hyprland · Wayland · CyberQueer
|
||||
|
||||
## Installation
|
||||
Production-grade Arch Linux config for network administration, development, and gaming.
|
||||
|
||||
<span style="color:red">
|
||||
!!! Please Read the instructions on Installation !!!
|
||||
</span>
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Installation instructions
|
||||
- Clone the Repository
|
||||
- Navigate to Dotfiles/setup
|
||||
- execute setup/autoformat.sh and accept the prompts on screen, for default partitioning layout
|
||||
- execute setup/live-install.sh and accept the prompts on screen
|
||||
- after being chrooted by setup/live-install.sh go to the Filesystem root and execute chroot-install.sh
|
||||
- reboot
|
||||
- run setup/install.sh
|
||||
- if needed run setup/modules/... to install additional preconfigured modules
|
||||
- reboot after running all desired installers
|
||||
## TODO
|
||||
### Prio
|
||||
- Finish the new install script
|
||||
```bash
|
||||
git clone https://git.abdelbaki.eu/The_miro/Dotfiles.git ~/Dotfiles
|
||||
bash ~/Dotfiles/setup/tui-install.sh
|
||||
```
|
||||
|
||||
### Ongoing tasks
|
||||
- move all config dirs that get modified after install to being copied to the client or linking individual files where relevant -> known offenders: micro, some nwg-shell components
|
||||
### Non-Prio
|
||||
- implement the hypr-ecosystem components: <s>hyprpwcenter,</s> hyprshutdown
|
||||
- solution for updates - Possibly using package list being read by script; Also possibly using git diff on some kind of .config manifest
|
||||
- clamav Module
|
||||
- eww sidebar popup menu ??? not sure on functionality yet - maybe cpu/ram/gpu usage
|
||||
The TUI installer covers: packages, desktop environment, optional apps, and colour palette.
|
||||
To add modules to an existing system: `bash ~/Dotfiles/setup/install-modules.sh`
|
||||
|
||||
### Completed
|
||||
- add screen rotation (script, keybind, eww widget) for touchscreens
|
||||
- some kind of per monitor startup script for the bar
|
||||
- set cmd+F1 to show a list of keybinds (regex on binds.conf???)
|
||||
- automatic monitor handling on new attatched
|
||||
- default to swapping esc and capslock in input.conf
|
||||
- Create Module for installing from the arch live enviroment
|
||||
- bluetooth tray icon
|
||||
- make toggling EWW bar less delayed -> only toggle the bar don't kill it
|
||||
- optional module that installs discord, steam
|
||||
- try to remove hyprland-git before installing
|
||||
- hyprsleep
|
||||
- make full gtk-4 theme
|
||||
- input config for use with touchscreens -> install+enable hyprgrass; button that enables hyprtabs?
|
||||
---
|
||||
|
||||
## Cliff Notes
|
||||
|
||||
- **Single source of truth for colours** — edit `colors.conf`, run `apply-theme.sh` to propagate everywhere.
|
||||
- **Answerfile** — generate with `setup/generate-answerfile.sh`, place at `/answerfile.json` for a fully automated install. Passwords are never stored in it.
|
||||
- **Hostname uniqueness** — the MAC address of the primary NIC is appended automatically when an answerfile hostname is set (`myhost` → `myhost-aabbccddee11`).
|
||||
- **LUKS encryption** — backup key is auto-generated from `/dev/urandom`, enrolled in a second LUKS slot, written to `/_LUKS_BACKUP_KEY` (root-only, inside the encrypted container). Collectable via Ansible.
|
||||
- **Custom ISO** — `setup/archiso/` builds a live USB that can embed a pre-baked answerfile for zero-touch deployment.
|
||||
- **Modular** — core, shell, services, and desktop are independent components; pick only what you need.
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
Full docs live in [`docs/md/`](docs/md/) (Markdown) and [`docs/html/`](docs/html/) (rendered).
|
||||
|
||||
| Topic | Markdown | HTML |
|
||||
|-------|----------|------|
|
||||
| Overview & repo layout | [index.md](docs/md/index.md) | [index.html](docs/html/index.html) |
|
||||
| Installation (TUI, answerfile, ISO) | [installation.md](docs/md/installation.md) | [installation.html](docs/html/installation.html) |
|
||||
| Hyprland desktop | [hyprland.md](docs/md/hyprland.md) | [hyprland.html](docs/html/hyprland.html) |
|
||||
| Theming & CyberQueer palette | [theming.md](docs/md/theming.md) | [theming.html](docs/html/theming.html) |
|
||||
| Optional modules & app catalogue | [modules.md](docs/md/modules.md) | [modules.html](docs/html/modules.html) |
|
||||
| Custom Archiso builder | [archiso.md](docs/md/archiso.md) | [archiso.html](docs/html/archiso.html) |
|
||||
| FreeIPA & Ansible | [freeipa-ansible.md](docs/md/freeipa-ansible.md) | [freeipa-ansible.html](docs/html/freeipa-ansible.html) |
|
||||
| Editors (Neovim, Micro, Yazi) | [editors.md](docs/md/editors.md) | [editors.html](docs/html/editors.html) |
|
||||
| Utilities (encrypt, ClamAV, updates) | [utilities.md](docs/md/utilities.md) | [utilities.html](docs/html/utilities.html) |
|
||||
|
||||
> The old readme is preserved at [`readme.md.old`](readme.md.old).
|
||||
|
|
|
|||
|
|
@ -0,0 +1,47 @@
|
|||
# Dotfiles
|
||||
|
||||
config for using arch linux in network administration, development and gaming
|
||||
|
||||
## Installation
|
||||
|
||||
<span style="color:red">
|
||||
!!! Please Read the instructions on Installation !!!
|
||||
</span>
|
||||
|
||||
|
||||
### Installation instructions
|
||||
- Clone the Repository
|
||||
- Navigate to Dotfiles/setup
|
||||
- execute setup/autoformat.sh and accept the prompts on screen, for default partitioning layout
|
||||
- execute setup/live-install.sh and accept the prompts on screen
|
||||
- after being chrooted by setup/live-install.sh go to the Filesystem root and execute chroot-install.sh
|
||||
- reboot
|
||||
- run setup/install.sh
|
||||
- if needed run setup/modules/... to install additional preconfigured modules
|
||||
- reboot after running all desired installers
|
||||
## TODO
|
||||
### Prio
|
||||
- Finish the new install script
|
||||
|
||||
### Ongoing tasks
|
||||
- move all config dirs that get modified after install to being copied to the client or linking individual files where relevant -> known offenders: micro, some nwg-shell components
|
||||
### Non-Prio
|
||||
- implement the hypr-ecosystem components: <s>hyprpwcenter,</s> hyprshutdown
|
||||
- solution for updates - Possibly using package list being read by script; Also possibly using git diff on some kind of .config manifest
|
||||
- clamav Module
|
||||
- eww sidebar popup menu ??? not sure on functionality yet - maybe cpu/ram/gpu usage
|
||||
|
||||
### Completed
|
||||
- add screen rotation (script, keybind, eww widget) for touchscreens
|
||||
- some kind of per monitor startup script for the bar
|
||||
- set cmd+F1 to show a list of keybinds (regex on binds.conf???)
|
||||
- automatic monitor handling on new attatched
|
||||
- default to swapping esc and capslock in input.conf
|
||||
- Create Module for installing from the arch live enviroment
|
||||
- bluetooth tray icon
|
||||
- make toggling EWW bar less delayed -> only toggle the bar don't kill it
|
||||
- optional module that installs discord, steam
|
||||
- try to remove hyprland-git before installing
|
||||
- hyprsleep
|
||||
- make full gtk-4 theme
|
||||
- input config for use with touchscreens -> install+enable hyprgrass; button that enables hyprtabs?
|
||||
Loading…
Reference in New Issue