diff --git a/README.md b/README.md new file mode 100644 index 0000000..f0dfcab --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +

+
+ ArchMinima Logo: Arch Linux logo tinted red +
+
+ +

+

+ Arch install script to build a fast, minimalistic, utilitarian interface. +

+ +

+ Release version + Release name + Supported OS versions +

+ +

ArchMinima aims to capture the minimalistic, clean layout of dwm while improving on some basic QoL aspects. The latest release, German Chamomile, is designed to be cloned or curled onto an Arch install ISO and piped into a local archive file.

+

+ Desktop screenshot: 9 tags, Memory status, Volume level, Available main storage availability, and date. Background is dark subway +

+ +## Table of Contents +- [Install](#install) +- [Modules](#modules) +- [Contributing](#contributing) +- [Credits](#credits) + +## Install +The `install.sh` script will ask you which disk you want to install to, so just give it an argument-less run: +```bash +git clone https://github.com/xero-lib/ArchMinima.git +cd ArchMinima/ +./install.sh +``` +## Modules +

Not yet implemented

+ +| Type | Name | Description | +| --- | --- | --- | +| default/ | desktop | Desktop environment or dwm customizations | +| default/ | firefox | Browser configuration | +| default/ | paru | Install and configure paru AUR helper | +| default/ | icons | Install and use Kora icons (for Plasma/Mate) | +| default/ | keybindings | more efficient or familiar Windows-like keybindings | +| default/ | login | Configure optional login screen or startx/wayland on login | +| default/ | shell | Install fish, configure, use as default | +| default/ | taskbar | Apply ArchMinima taskbar layout (for Plasma/Mate) | +| default/ | terminal | Alacritty/Kitty configuration | +| default/ | theme | Install Orchis (Mate), set as WM and DE theme | +| default/ | vim | Vim configuration, color scheme, plugin configuration | +| default/ | wallpapers | Install wallpapers | +| optional/ | discord | Install Discord (requires AUR helper) | +| optional/ | minecraft | Install Minecraft launcher (requires AUR helper) | +| optional/ | obs | Install OBS and ffmpeg-obs, setup replay buffer | +| optional/ | spotify | Install Spotify | +| optional/ | steam | Install Steam | + +## Contributing +Pull requests adding new modules or editing existing ones are welcome, but if I don't think I would use it myself I can't promise to merge it. If you have any doubt, [issues](https://github.com/xero-lib/ArchMinima/issues) are also encouraged and I'll let you know if it's something I'd be willing to merge or work on myself. + +## Credits +README inspired and largely copied from [Skyler Spaeth](https://github.com/skylerspaeth) and his project [SkyOS](https://github.com/skylerspaeth/SkyOS). + +This project wouldn't be possible without the hard work of many hundreds of open source projects' contributors this script installs, directly or indirectly.