mirror of
https://github.com/javalsai/lidm.git
synced 2025-08-31 02:18:00 +02:00
docs: linter & packagers guide & chores (#64)
add prettier, move most markdown into `docs/` and add a packagers guide --- * lint(md): add prettier * docs(packagers): add a guide * docs(correctness): Index -> ToC * docs: link to package maintainers guide * docs: move install docs to `./docs` * docs(fix): typo
This commit is contained in:
GitHub
67
README.md
67
README.md
@@ -10,26 +10,23 @@ LiDM is like any [Display Manager](https://en.wikipedia.org/wiki/X_display_manag
|
||||
|
||||
|
||||
|
||||
> *shown as in a featured terminal emulator, actual linux console doesn't support as much color and decorations*
|
||||
> _shown as in a featured terminal emulator, actual linux console doesn't support as much color and decorations_
|
||||
|
||||
> *however, all colors and strings are fully customizable*
|
||||
> _however, all colors and strings are fully customizable_
|
||||
|
||||
## Features
|
||||
|
||||
* Simple as C, you only need a C compiler and standard unix libraries to build this.
|
||||
* Fully customizable, from strings, including action keys, to colors (I hope you know ansi escape codes)
|
||||
* Automatically detects xorg and wayland sessions, plus allowing to launch the default user shell (if enabled in config)
|
||||
* Starts with many init systems (systemd, dinit, runit, openrc and s6).
|
||||
- Simple as C, you only need a C compiler and standard unix libraries to build this.
|
||||
- Fully customizable, from strings, including action keys, to colors (I hope you know ansi escape codes)
|
||||
- Automatically detects xorg and wayland sessions, plus allowing to launch the default user shell (if enabled in config)
|
||||
- Starts with many init systems (systemd, dinit, runit, openrc and s6).
|
||||
|
||||
# Index
|
||||
# Table of Contents
|
||||
|
||||
- [LiDM](#lidm)
|
||||
- [Features](#features)
|
||||
- [Index](#index)
|
||||
- [Ideology](#ideology)
|
||||
- [Usage](#usage)
|
||||
- [Arguments](#arguments)
|
||||
- [Program](#program)
|
||||
- [Arguments](#arguments)
|
||||
- [Program](#program)
|
||||
- [Requirements](#requirements)
|
||||
- [Installation](#installation)
|
||||
- [Configuring](#configuring)
|
||||
@@ -44,7 +41,7 @@ We all know that the most important thing in a project is the ideology of the au
|
||||
|
||||
[  ](https://stopchatcontrol.eu)
|
||||
|
||||
> *there's also a [change.org post](https://www.change.org/p/stoppt-die-chatkontrolle-grundrechte-gelten-auch-im-netz).*
|
||||
> _there's also a [change.org post](https://www.change.org/p/stoppt-die-chatkontrolle-grundrechte-gelten-auch-im-netz)._
|
||||
|
||||
# Usage
|
||||
|
||||
@@ -56,25 +53,33 @@ If a single argument is provided (don't even do `--` or standard unix parsing...
|
||||
|
||||
Base (mostly intuitive):
|
||||
|
||||
* Use arrow keys to navigate the inputs and type over any of them to override the default value.
|
||||
* Enter will just attempt to login.
|
||||
* If you are focused on an edited input, horizontal arrow keys will attempt to move across the text just as expected.
|
||||
- Use arrow keys to navigate the inputs and type over any of them to override the default value.
|
||||
- Enter will just attempt to login.
|
||||
- If you are focused on an edited input, horizontal arrow keys will attempt to move across the text just as expected.
|
||||
|
||||
On top of that:
|
||||
|
||||
* Using the horizontal arrow keys if the focused input is not in text mode or the movement would overflow the input. It will try to change in such direction the option of session or the user.
|
||||
* Pressing <kbd>ESC</kbd> and then horizontal arrows will force to change the option of the focused input even if it's in edit mode.
|
||||
* Editing an option on a user or a shell session will put you in edit mode appending after the original value.
|
||||
- Using the horizontal arrow keys if the focused input is not in text mode or the movement would overflow the input. It will try to change in such direction the option of session or the user.
|
||||
- Pressing <kbd>ESC</kbd> and then horizontal arrows will force to change the option of the focused input even if it's in edit mode.
|
||||
- Editing an option on a user or a shell session will put you in edit mode appending after the original value.
|
||||
|
||||
# Requirements
|
||||
|
||||
* Make (Also optional, but does things automatically, make sure `gcc` and `mkdir -p` work as expected).
|
||||
* A compiler like `cc`, `gcc` or `clang`. Make sure to use the desired `CC=<compiler>` on the `make` command.
|
||||
* PAM library, used for user authentication, just what `login` or `su` use internally. Don't worry, it's surely pre-installed.
|
||||
- Make (Also optional, but does things automatically, make sure `gcc` and `mkdir -p` work as expected).
|
||||
- A compiler like `cc`, `gcc` or `clang`. Make sure to use the desired `CC=<compiler>` on the `make` command.
|
||||
- PAM library, used for user authentication, just what `login` or `su` use internally. Don't worry, it's surely pre-installed.
|
||||
|
||||
# Installation
|
||||
|
||||
Check the [installation guide](INSTALL.md) to use your preferred installation source.
|
||||
Check the [installation guide](./docs/INSTALL.md) to use your preferred installation source.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Packagers read here!!</summary>
|
||||
|
||||
If you are a package maintainer or are willing to become one, please read [the packagers guide](./docs/PACKAGERS.md).
|
||||
|
||||
</details>
|
||||
|
||||
# Configuring
|
||||
|
||||
@@ -92,7 +97,7 @@ Colors are gonna be put inside `\x1b[...m`, if you don't know what this is check
|
||||
|
||||
# PAM
|
||||
|
||||
If your distribution does not use the standard PAM service name `login` (`/etc/pam.d/login`) for its PAM services or if you want to use another PAM file, simply set the `LIDM_PAM_SERVICE` env variable to your PAM service name.
|
||||
If your distribution does not use the standard PAM service name `login` (`/etc/pam.d/login`) for its PAM services or if you want to use another PAM file, simply set the `LIDM_PAM_SERVICE` env variable to your PAM service name.
|
||||
|
||||
When the env variable is empty it defaults to the `login` PAM service or whatever fallback your distribution packager has defined during compilation.
|
||||
|
||||
@@ -108,21 +113,21 @@ For this reason the project's philosophy is to be simple and minimal, such that
|
||||
|
||||
I forgot what exactly the name came from, but it surely was a mix of a few things so:
|
||||
|
||||
* Obviously it's inspired by `ly`. `ly-dm` leads to "lydm".
|
||||
* Wow make "lydm" simple with a "y" → "i" transformation.
|
||||
* Associate it with the "i" in s**i**mple and other display managers like **Li**ghtDM.
|
||||
* And the **la**ptop this project started in has a **lid**.
|
||||
- Obviously it's inspired by `ly`. `ly-dm` leads to "lydm".
|
||||
- Wow make "lydm" simple with a "y" → "i" transformation.
|
||||
- Associate it with the "i" in s**i**mple and other display managers like **Li**ghtDM.
|
||||
- And the **la**ptop this project started in has a **lid**.
|
||||
|
||||
# Contributors
|
||||
|
||||
[](https://github.com/javalsai/lidm/graphs/contributors)
|
||||
[](https://github.com/javalsai/lidm/graphs/contributors)
|
||||
|
||||
[killertofus](https://github.com/killertofus), [deadvey](https://github.com/deadvey), [grialion](https://github.com/grialion/), cerealexperiments\_, [antiz96](https://github.com/Antiz96), [rmntgx](https://github.com/rmntgx) and [more...](https://github.com/javalsai/lidm/graphs/contributors)
|
||||
|
||||
With their big or small contributions, every commit has helped in its own way and encouraged me to keep putting my soul into this.
|
||||
|
||||
***
|
||||
---
|
||||
|
||||
🌟 Finally, consider starring this repo [or...](https://www.reddit.com/r/github/comments/1l2mchg/is_this_allowed) 🔪
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user