fix: New README, new documentation for developpers, and many install.sh and update.sh fixes
This commit is contained in:
Gu://em_
parent
38d2572e84
commit
6b92f7a0a0
5 changed files with 282 additions and 45 deletions
103
README.md
103
README.md
|
|
@ -1,52 +1,99 @@
|
|||
# Atlas Desktop installer
|
||||
# Atlas Desktop
|
||||
|
||||
This project is an automated installer for the Atlas Desktop.
|
||||
A fully automated Archlinux setup for people that care about their computer.
|
||||
|
||||
## Disclaimer
|
||||
```sh
|
||||
curl -fsSL https://forge.oblic-parallels.fr/guillm/atlas-desktop/raw/branch/main/scripts/install.sh | bash
|
||||
```
|
||||
|
||||
### ⚠ Use at your own risk.
|
||||
|
||||
Some platforms may not yet be supported such as Nvidia graphic cards for which you'll have to install all the drivers yourself. Sadly I don't have any equipment to test that out.
|
||||
|
||||
Also you will very probably miss some software you're used to. I'll strongly recommend you to check the [Additionnal packages](https://hedgedoc.oblic-parallels.fr/s/JSR33pjd_#Additional-packages) section to know about some open source utilities that fit perfectly within the desktop.
|
||||
More generally give a look to the [Quick start guide](https://hedgedoc.oblic-parallels.fr/s/JSR33pjd_)
|
||||
|
||||
If something doesn't work or behaves anormally don't hesitate to contact me so that it will be fixed for future users.
|
||||
## What's included
|
||||
|
||||
- **Window manager**: Hyprland
|
||||
- **Status bar**: Waybar
|
||||
- **Display manager**: Ly
|
||||
- **Launcher**: Rofi
|
||||
- **Notifications center**: Swaync
|
||||
- **Terminal**: Foot
|
||||
- **Shell**: Zsh + Zinit + Powerlevel10k
|
||||
|
||||
|
||||
## Requirements
|
||||
|
||||
You'll just need an already functional (even basic) **Arch Linux** system with `sudo` installed.
|
||||
Setup will take care of configuring AppArmor and Zram if it hasn't been done yet.
|
||||
- A basic Arch Linux install (cli is enough, no DE required)
|
||||
- A user account with `sudo` access
|
||||
- `git` installed (`sudo pacman -Sy git`)
|
||||
- Internet connection
|
||||
|
||||
Setup will take care of configuring AppArmor and Zram or even firewall if you haven't done it yet.
|
||||
|
||||
## Installation
|
||||
|
||||
**Disclaimer**: Some platforms may not yet be supported such as Nvidia graphic cards for which you'll have to install all the drivers yourself. Sadly I don't have any equipment to test that out.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Very simple, clone the project (or download it directly from the web interface)
|
||||
```sh=
|
||||
git clone https://forge.oblic-parallels.fr/guillm/atlas-install
|
||||
```sh
|
||||
curl -fsSL https://forge.oblic-parallels.fr/guillm/atlas-desktop/raw/branch/main/scripts/install.sh | bash
|
||||
```
|
||||
And run `setup.sh`
|
||||
```sh=
|
||||
./setup.sh
|
||||
```
|
||||
|
||||
Then just follow the instructions and you should be good to go !
|
||||
If you encounter any error or bug, don't hesitate to open an issue on this repo.
|
||||
After the setup finishes you may need to reboot in order to login:
|
||||
```sh
|
||||
sudo reboot
|
||||
```
|
||||
|
||||
> **Note**: If you encounter any error or bug, don't hesitate to open an issue on this repo.
|
||||
|
||||
> **Note:** After installation the original clone is no longer needed.
|
||||
> `~/.dotfiles` is the real repo and is what the updater tracks.
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
I suggest you to give a look to the packages that will be installed on your system as it's important to know how things will work or to disable some things you wouldn't necessarely want.
|
||||
I particularly think of helix which is used as the default text editor but may not suit some people needs.
|
||||
I suggest you to give a look to the [Quick start guide](https://hedgedoc.oblic-parallels.fr/s/JSR33pjd_) that explains how the system works if you're not used to it.
|
||||
As you will very probably miss some software you're used to. I'll strongly recommend you to check the [Additionnal packages](https://hedgedoc.oblic-parallels.fr/s/JSR33pjd_#Additional-packages) section to know about some open source utilities that fit perfectly within the desktop.
|
||||
|
||||
Note that the default keyboard layout is QWERTY (us-fr). You can switch with the AZERTY layout by using `Mod+Ctrl+Space`. That said, the default layout already has french accents if you need them.
|
||||
If you need to modify the layout, go to `~/.config/hypr/config/default/kb_layouts`.
|
||||
|
||||
### Defaults
|
||||
|
||||
I'm working on a system to easily change the default programs. I don't know yet if it will result into anything but it's worth trying.
|
||||
## Staying up to date
|
||||
|
||||
```sh
|
||||
atlas-update
|
||||
```
|
||||
|
||||
This will:
|
||||
|
||||
- Fetch origin/main and show new commits
|
||||
- Detect conflicts between upstream changes and local edits, asking you which to keep per file
|
||||
- Pull and re-stow config/
|
||||
- Re-prompt for any new optional groups added upstream
|
||||
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Stow reports conflicts on first install**
|
||||
- Existing real files that clash with stow links are automatically renamed to `<file>.bak`.
|
||||
|
||||
**An AUR package failed to install**
|
||||
- The installer reports it and continues. It won't be saved to state, so `atlas-update` will retry it next run.
|
||||
|
||||
**`atlas-update` says "already up to date" but a package is missing**
|
||||
- Delete its state file to force a re-sync:
|
||||
```bash
|
||||
rm ~/.atlas-dotfiles/.state/packages/mygroup.pkgs
|
||||
atlas-update
|
||||
```
|
||||
|
||||
**Waybar doesn't reload after switching layout**
|
||||
- Reload desktop using `Mod+Shift+R` or run the following command:
|
||||
```bash
|
||||
pkill waybar && waybar &
|
||||
```
|
||||
|
||||
|
||||
## Future improvements
|
||||
|
||||
- Waybar switch script
|
||||
- A defaults system allowing you to easily choose your default programs
|
||||
- Nvidia cards handling
|
||||
- Cleaner way to enable/disable some packages / configuratuions
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue