From f485840d89e1c45dccc27bb61e7f1d4fdd5bb941 Mon Sep 17 00:00:00 2001 From: KR1470R Date: Sun, 22 May 2022 22:26:32 +0300 Subject: [PATCH 1/3] add aur support --- readme.md | 125 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 125 insertions(+) diff --git a/readme.md b/readme.md index fa5b09e2..52df5ca7 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,4 @@ + # Ly - a TUI display manager ![Ly screenshot](https://user-images.githubusercontent.com/5473047/88958888-65efbf80-d2a1-11ea-8ae5-3f263bce9cce.png "Ly screenshot") @@ -113,6 +114,130 @@ To enable the famous PSX DOOM fire described by [Fabien Sanglard](http://fabiens just uncomment `animate = true` in `/etc/ly/config.ini`. You may also disable the main box borders with `hide_borders = true`. +## Additional Information +The name "Ly" is a tribute to the fairy from the game Rayman. +Ly was tested by oxodao, who is some seriously awesome dude.# Ly - a TUI display manager +![Ly screenshot](https://user-images.githubusercontent.com/5473047/88958888-65efbf80-d2a1-11ea-8ae5-3f263bce9cce.png "Ly screenshot") + +Ly is a lightweight TUI (ncurses-like) display manager for Linux and BSD. + +## Dependencies + - a C99 compiler (tested with tcc and gcc) + - a C standard library + - GNU make + - pam + - xcb + - xorg + - xorg-xauth + - mcookie + - tput + - shutdown + +On Debian-based distros running `apt install build-essential libpam0g-dev libxcb-xkb-dev` as root should install all the dependencies for you. + +## Support +The following desktop environments were tested with success + - bspwm + - budgie + - cinnamon + - deepin + - dwm + - enlightenment + - gnome + - i3 + - kde + - lxde + - lxqt + - mate + - qtile + - sway + - xfce + - pantheon + - maxx + - windowmaker + +Ly should work with any X desktop environment, and provides +basic wayland support (sway works very well, for example). + +## systemd? +Unlike what you may have heard, Ly does not require `systemd`, +and was even specifically designed not to depend on `logind`. +You should be able to make it work easily with a better init, +changing the source code won't be necessary :) + +## Cloning and Compiling +Clone the repository +``` +git clone --recurse-submodules https://github.com/nullgemm/ly.git +``` + +Compile +``` +make +``` + +Test in the configured tty (tty2 by default) +or a terminal emulator (but desktop environments won't start) +``` +sudo make run +``` + +Install Ly and the provided systemd service file +``` +sudo make install +``` + +Enable the service +``` +sudo systemctl enable ly.service +``` + +If you need to switch between ttys after Ly's start you also have to +disable getty on Ly's tty to prevent "login" from spawning on top of it +``` +sudo systemctl disable getty@tty2.service +``` + +## Arch Linux Installation +From AUR: +``` +yay -S ly-aur +``` + +## Configuration +You can find all the configuration in `/etc/ly/config.ini`. +The file is commented, and includes the default values. + +## Controls +Use the up and down arrow keys to change the current field, and the +left and right arrow keys to change the target desktop environment +while on the desktop field (above the login field). + +## .xinitrc +If your .xinitrc doesn't work make sure it is executable and includes a shebang. +This file is supposed to be a shell script! Quoting from xinit's man page: +``` +If no specific client program is given on the command line, xinit will look for +a file in the user's home directory called .xinitrc to run as a shell script to +start up client programs. +``` +On ArchLinux, the example .xinitrc (/etc/X11/xinit/xinitrc) starts like this: +``` +#!/bin/sh +``` + +## Tips +The numlock and capslock state is printed in the top-right corner. +Use the F1 and F2 keys to respectively shutdown and reboot. +Take a look at your .xsession if X doesn't start, as it can interfere +(this file is launched with X to configure the display properly). + +## PSX DOOM fire animation +To enable the famous PSX DOOM fire described by [Fabien Sanglard](http://fabiensanglard.net/doom_fire_psx/index.html), +just uncomment `animate = true` in `/etc/ly/config.ini`. You may also +disable the main box borders with `hide_borders = true`. + ## Additional Information The name "Ly" is a tribute to the fairy from the game Rayman. Ly was tested by oxodao, who is some seriously awesome dude. + From 83c17b7b783ffd1114695ebaa067ed9b0b50b887 Mon Sep 17 00:00:00 2001 From: KRIPTOR Date: Mon, 23 May 2022 22:20:45 +0300 Subject: [PATCH 2/3] Update readme.md --- readme.md | 118 ------------------------------------------------------ 1 file changed, 118 deletions(-) diff --git a/readme.md b/readme.md index 52df5ca7..7b0970e0 100644 --- a/readme.md +++ b/readme.md @@ -81,123 +81,6 @@ disable getty on Ly's tty to prevent "login" from spawning on top of it sudo systemctl disable getty@tty2.service ``` -## Configuration -You can find all the configuration in `/etc/ly/config.ini`. -The file is commented, and includes the default values. - -## Controls -Use the up and down arrow keys to change the current field, and the -left and right arrow keys to change the target desktop environment -while on the desktop field (above the login field). - -## .xinitrc -If your .xinitrc doesn't work make sure it is executable and includes a shebang. -This file is supposed to be a shell script! Quoting from xinit's man page: -``` -If no specific client program is given on the command line, xinit will look for -a file in the user's home directory called .xinitrc to run as a shell script to -start up client programs. -``` -On ArchLinux, the example .xinitrc (/etc/X11/xinit/xinitrc) starts like this: -``` -#!/bin/sh -``` - -## Tips -The numlock and capslock state is printed in the top-right corner. -Use the F1 and F2 keys to respectively shutdown and reboot. -Take a look at your .xsession if X doesn't start, as it can interfere -(this file is launched with X to configure the display properly). - -## PSX DOOM fire animation -To enable the famous PSX DOOM fire described by [Fabien Sanglard](http://fabiensanglard.net/doom_fire_psx/index.html), -just uncomment `animate = true` in `/etc/ly/config.ini`. You may also -disable the main box borders with `hide_borders = true`. - -## Additional Information -The name "Ly" is a tribute to the fairy from the game Rayman. -Ly was tested by oxodao, who is some seriously awesome dude.# Ly - a TUI display manager -![Ly screenshot](https://user-images.githubusercontent.com/5473047/88958888-65efbf80-d2a1-11ea-8ae5-3f263bce9cce.png "Ly screenshot") - -Ly is a lightweight TUI (ncurses-like) display manager for Linux and BSD. - -## Dependencies - - a C99 compiler (tested with tcc and gcc) - - a C standard library - - GNU make - - pam - - xcb - - xorg - - xorg-xauth - - mcookie - - tput - - shutdown - -On Debian-based distros running `apt install build-essential libpam0g-dev libxcb-xkb-dev` as root should install all the dependencies for you. - -## Support -The following desktop environments were tested with success - - bspwm - - budgie - - cinnamon - - deepin - - dwm - - enlightenment - - gnome - - i3 - - kde - - lxde - - lxqt - - mate - - qtile - - sway - - xfce - - pantheon - - maxx - - windowmaker - -Ly should work with any X desktop environment, and provides -basic wayland support (sway works very well, for example). - -## systemd? -Unlike what you may have heard, Ly does not require `systemd`, -and was even specifically designed not to depend on `logind`. -You should be able to make it work easily with a better init, -changing the source code won't be necessary :) - -## Cloning and Compiling -Clone the repository -``` -git clone --recurse-submodules https://github.com/nullgemm/ly.git -``` - -Compile -``` -make -``` - -Test in the configured tty (tty2 by default) -or a terminal emulator (but desktop environments won't start) -``` -sudo make run -``` - -Install Ly and the provided systemd service file -``` -sudo make install -``` - -Enable the service -``` -sudo systemctl enable ly.service -``` - -If you need to switch between ttys after Ly's start you also have to -disable getty on Ly's tty to prevent "login" from spawning on top of it -``` -sudo systemctl disable getty@tty2.service -``` - ## Arch Linux Installation From AUR: ``` @@ -240,4 +123,3 @@ disable the main box borders with `hide_borders = true`. ## Additional Information The name "Ly" is a tribute to the fairy from the game Rayman. Ly was tested by oxodao, who is some seriously awesome dude. - From 9e33f90d244b3d84805f845b8168e20f3c4a5e85 Mon Sep 17 00:00:00 2001 From: KRIPTOR Date: Wed, 25 May 2022 19:39:15 +0300 Subject: [PATCH 3/3] Update readme.md --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 7b0970e0..83c90834 100644 --- a/readme.md +++ b/readme.md @@ -84,7 +84,7 @@ sudo systemctl disable getty@tty2.service ## Arch Linux Installation From AUR: ``` -yay -S ly-aur +yay -S ly ``` ## Configuration