atlas-desktop/README.md

# Atlas Desktop installer

This project is an automated installer for the Atlas Desktop.

## Disclaimer

### ⚠ 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.


## 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.


## 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
```
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.

## 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.

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.

## Future improvements

- Nvidia cards handling
- Cleaner way to enable/disable some packages / configuratuions