RomanNum3ral
/
ly
mirror of https://github.com/fairyglade/ly.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tidy up readme.md 

Signed-off-by: AnErrupTion <anerruption@disroot.org>
This commit is contained in:
AnErrupTion 2024-05-04 23:12:36 +02:00
parent 818089354a
commit 9df54fe980
No known key found for this signature in database
GPG Key ID: 3E85EB44F610AD7F
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
readme.md
View File

@ -5,7 +5,7 @@
Ly is a lightweight TUI (ncurses-like) display manager for Linux and BSD. Ly is a lightweight TUI (ncurses-like) display manager for Linux and BSD.
## Dependencies ## Dependencies
- zig - zig 0.12.0
- a C standard library - a C standard library
- pam - pam
- xcb - xcb
@ -15,14 +15,21 @@ Ly is a lightweight TUI (ncurses-like) display manager for Linux and BSD.
- tput - tput
- shutdown - shutdown
On Debian-based distros running `apt install build-essential libpam0g-dev libxcb-xkb-dev` as root should install all the dependencies for you. ### Debian
For Fedora try running `dnf install kernel-devel pam-devel libxcb-devel` ```
# apt install build-essential libpam0g-dev libxcb-xkb-dev
```
You can download Zig [here](https://ziglang.org/download/). ### Fedora
**Warning**: You may encounter issues with SELinux on Fedora.
It is recommended to add a rule for Ly as it currently does not ship one.
```
# dnf install kernel-devel pam-devel libxcb-devel
```
## Support ## Support
The following desktop environments were tested with success The following desktop environments were tested with success:
- awesome - awesome
- bspwm - bspwm
- budgie - budgie
@ -111,7 +118,8 @@ Enable the service
You can edit which tty Ly will start on by editing the `tty` option in the configuration file. You can edit which tty Ly will start on by editing the `tty` option in the configuration file.
If you choose a tty that already has a login/getty running (has a basic login prompt), then you have to disable the getty so it doesn't respawn on top of ly If you choose a tty that already has a login/getty running (has a basic login prompt),
then you have to disable getty, so it doesn't respawn on top of ly
``` ```
# rc-update del agetty.tty2 # rc-update del agetty.tty2
``` ```
@ -131,7 +139,9 @@ You should as well disable your existing display manager service if needed, e.g.
# rm /var/service/lxdm # rm /var/service/lxdm
``` ```
The agetty service for the tty console where you are running ly should be disabled. For instance, if you are running ly on tty2 (that's the default, check your `/etc/ly/config.ini`) you should disable the agetty-tty2 service like this: The agetty service for the tty console where you are running ly should be disabled.
For instance, if you are running ly on tty2 (that's the default, check your `/etc/ly/config.ini`)
you should disable the agetty-tty2 service like this:
``` ```
# rm /var/service/agetty-tty2 # rm /var/service/agetty-tty2