diff --git a/LICENSE.md b/license.md similarity index 100% rename from LICENSE.md rename to license.md diff --git a/README.md b/readme.md similarity index 94% rename from README.md rename to readme.md index 7ef9b49..8ddc700 100644 --- a/README.md +++ b/readme.md @@ -1,10 +1,10 @@ -### Ly - a TUI display manager +# Ly - a TUI display manager [![CodeFactor](https://www.codefactor.io/repository/github/cylgom/ly/badge/master)](https://www.codefactor.io/repository/github/cylgom/ly/overview/master) ![ly screenshot](https://user-images.githubusercontent.com/5473047/42466218-8cb53d3c-83ae-11e8-8e53-bae3669f959c.png "ly on st") Ly is a lightweight, TUI (ncurses-like) display manager for Linux. -### Dependencies +## Dependencies Make sure all the following packages are properly installed and configured before going further: - a C99 compiler (tested with gcc and tcc) @@ -18,7 +18,7 @@ before going further: - tput - shutdown -### Cloning and Compiling +## Cloning and Compiling This repository uses submodules, to clone it properly please use ``` git clone --recurse-submodules https://github.com/cylgom/ly.git @@ -58,22 +58,22 @@ edit open the configuration and make sure `force_update` is enabled force_update=1 ``` -### Configuration +## Configuration All the configuration takes place in `/etc/ly/config.ini`. The file is commented, and includes useful defaults. -### Controls +## 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). -### Tips +## 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). -### Additional Information +## 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. I wish to thank linux-pam, X11 and systemd developers for not