mirror of
https://github.com/javalsai/lidm.git
synced 2026-02-27 03:50:44 +01:00
chore: misc (#100) (this makes 2.0.0)
Co-authored-by: grialion <48643945+grialion@users.noreply.github.com> - Fix license ambiguity (#88) - just the only/or-later ambiguity point, not adding SPDX identifyiers unless more people request it - Better document kmscon (#91) - Make 2.0.0 already to close #86 - Add a changelog - Add packagers info (acutally just add them to install guide) - Add AUR service packages (I'll take care of systemd and dinit, let others package the rest and leave systemd open for someone who actually uses it in docs) - Make sure all makefile installs to `/usr/local` by default - Simplify Makefile complexity by several orders
This commit is contained in:
GitHub
134
docs/INSTALL.md
134
docs/INSTALL.md
@@ -1,63 +1,73 @@
|
||||
# Table of Contents
|
||||
|
||||
- [Packages](#packages)
|
||||
- [Void Linux](#void-linux)
|
||||
- [Fedora](#fedora)
|
||||
- [AUR](#aur)
|
||||
- [Nix Flake](#nix-flake)
|
||||
- [Nix Module](#nix-module)
|
||||
- [Installing from Source](#installing-from-source)
|
||||
- [AUR](#aur)
|
||||
- [Nix Flake](#nix-flake)
|
||||
- [Nix Module](#nix-module)
|
||||
|
||||
> [!CAUTION]
|
||||
> I encourage you to read the manual installation steps to understand what will get installed in your computer by this package.
|
||||
# Packages
|
||||
|
||||
# Installing from Source
|
||||
Lidm relies on its community to package lidm for distributions and make the installation easier for everyone. Please raise any issues on the packages themselves and not the source repository.
|
||||
|
||||
Firstly, you'll need to build the package, this also includes man pages, default config, themes and other files you might need.
|
||||
If you packaged lidm for any distribution not listed here or keep your own version of an inactive package, feel free to contact me to be added here. (could be a GitHub discussion or an email if you don't use GitHub)
|
||||
|
||||
To build it you only need to have some basic packages (should come pre-installed in almost all distros): `make`, `gcc` or another `gcc`ish compiler, and libpam headers. If it builds, it surely works anyways.
|
||||
These packages just install lidm, once installed you have to enable it. It depends on your init system, but if you're using systemd (most likely), first find your currently active display manager (if any, examples are `sddm`, `gdm`, `ly`) and disable it:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/javalsai/lidm.git
|
||||
cd lidm
|
||||
make # 👍
|
||||
systemctl disable <display manager name here>
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> There's pre-built binaries on the [releases tab](https://github.com/javalsai/lidm/releases) too.
|
||||
|
||||
Then you can install the files onto your filesystem with:
|
||||
And then enable lidm:
|
||||
|
||||
```sh
|
||||
make install
|
||||
systemctl enable lidm
|
||||
```
|
||||
|
||||
And additionally, to install service files (start-up behavior). <sup>[more docs](../assets/services/README.md)</sup>
|
||||
Lidm now should show on the next boot!
|
||||
|
||||
If you are on a TTY and don't wish to reboot, you should be able to use `--now` with both commands. It's likely to kill your current desktop environment if it was launched from it.
|
||||
|
||||
## Void Linux
|
||||
|
||||
Lidm can be installed from the official Void Linux packages:
|
||||
|
||||
```sh
|
||||
# automatically detects your init system
|
||||
# and install service file (for tty7)
|
||||
make install-service
|
||||
|
||||
# or if you don't like autodetection
|
||||
make install-service-systemd # systemd
|
||||
make install-service-dinit # dinit
|
||||
make install-service-runit # runit (/etc/sv)
|
||||
make install-service-runit-etc # runit (/etc/runit/sv)
|
||||
make install-service-openrc # openrc
|
||||
make install-service-s6 # s6 (/etc/sv)
|
||||
make install-service-s6-etc # s6 (/etc/s6/sv)
|
||||
|
||||
# For runit and s6, some distros (e.g. Artix) like to put it in /etc/<init>/sv
|
||||
# to better isolate their packages while other distros (e.g. Void) just put it
|
||||
# in /etc/sv
|
||||
xbps-install lidm
|
||||
```
|
||||
|
||||
# AUR
|
||||
To enable the service that starts on boot:
|
||||
|
||||
[AUR packages](https://aur.archlinux.org/packages?K=lidm&SeB=n) will automatically install most files.
|
||||
```sh
|
||||
ln -s /etc/sv/lidm /var/service/
|
||||
```
|
||||
|
||||
> [!CAUTION]
|
||||
> [service files](../assets/pkg/aur#services) have to be manually installed by now.
|
||||
It is recommended to disable any other display managers that are still enabled:
|
||||
|
||||
# Nix Flake
|
||||
```sh
|
||||
touch /etc/sv/lightdm/down # replace lightdm with your previous display manager (e.g., sddm, gdm)
|
||||
```
|
||||
|
||||
|
||||
## Fedora
|
||||
|
||||
Thanks to @KernelFreeze there's a COPR repo available at <https://copr.fedorainfracloud.org/coprs/celestelove/lidm/> to install lidm. (<https://github.com/javalsai/lidm/discussions/92>)
|
||||
|
||||
## AUR
|
||||
|
||||
There are several [AUR packages](https://aur.archlinux.org/packages?K=lidm&SeB=n) for most things. You only need to install one of the following:
|
||||
|
||||
* `lidm`
|
||||
* `lidm-bin`
|
||||
* `lidm-git`
|
||||
|
||||
Each of those depend on `lidm-service` which is provided by `lidm-systemd` and `lidm-dinit` (you'll have to pick one). I maintain both but I'm open to anyone that actually uses systemd to take the first one.
|
||||
|
||||
There's packagers needed for openrc, s6 and runit. If you know how to make AUR packages, feel free to take any of those if you use each init system.
|
||||
|
||||
## Nix Flake
|
||||
|
||||
You can install by doing
|
||||
|
||||
@@ -72,9 +82,9 @@ nix run github:javalsai/lidm
|
||||
```
|
||||
|
||||
> [!CAUTION]
|
||||
> This doesn't include [service files](../assets/pkg/aur#services) neither
|
||||
> This doesn't include [service files](../assets/pkg/aur#services)
|
||||
|
||||
# Nix Module
|
||||
## Nix Module
|
||||
|
||||
<details>
|
||||
<summary>Sidenote</summary>
|
||||
@@ -126,3 +136,47 @@ with config.lidm.keysEnum; {
|
||||
|
||||
> [!NOTE]
|
||||
> [service files](../assets/pkg/aur#services) **are** included and enabled
|
||||
|
||||
# Installing from Source
|
||||
|
||||
Firstly, you'll need to build the package, this also includes man pages, default config, themes and other files you might need.
|
||||
|
||||
To build it you only need to have some basic packages (should come pre-installed in almost all distros): `make`, `gcc` or another `gcc`ish compiler, and libpam headers. If it builds, it surely works anyways.
|
||||
|
||||
```sh
|
||||
git clone https://github.com/javalsai/lidm.git
|
||||
cd lidm
|
||||
make # 👍
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> There are pre-built binaries on the [releases tab](https://github.com/javalsai/lidm/releases) too.
|
||||
|
||||
Then you can install the files onto your filesystem with:
|
||||
|
||||
```sh
|
||||
make install
|
||||
```
|
||||
|
||||
This will install mostly into `/usr/local` by default, this path is mostly unused nowadays (systemd can load services from it but man usually doesn't find manual pages in there) and could feel like lidm didn't install at all. You can add `PREFIX=/usr` to install along the rest of your system packages if you wish.
|
||||
|
||||
And additionally, to install service files (start-up behavior). <sup>[more docs](../assets/services/README.md)</sup>
|
||||
|
||||
```sh
|
||||
# automatically detects your init system
|
||||
# and install service file (for tty7)
|
||||
make install-service
|
||||
|
||||
# or if you don't like autodetection
|
||||
make install-service-systemd # systemd
|
||||
make install-service-dinit # dinit
|
||||
make install-service-runit # runit (/etc/sv)
|
||||
make install-service-runit-etc # runit (/etc/runit/sv)
|
||||
make install-service-openrc # openrc
|
||||
make install-service-s6 # s6 (/etc/sv)
|
||||
make install-service-s6-etc # s6 (/etc/s6/sv)
|
||||
|
||||
# For runit and s6, some distros (e.g. Artix) like to put it in /etc/<init>/sv
|
||||
# to better isolate their packages while other distros (e.g. Void) just put it
|
||||
# in /etc/sv
|
||||
```
|
||||
|
||||
@@ -53,7 +53,9 @@ But this can be changed by just passing those env variables, for example, in the
|
||||
|
||||
## Target Directory
|
||||
|
||||
`DESTDIR` can be used to for installation recipes to install on alternative root directories. Along with `PREFIX` (defaults to `/usr`) for systems which don't use the common `/usr` structure. e.g. `make install DESTDIR=$out PREFIX=`
|
||||
`DESTDIR` can be used to for installation recipes to install on alternative root directories. Along with `PREFIX` (defaults to `/usr/local`, packaging this you'll probably want to make it `/usr`) for systems which don't use the common `/usr` structure. e.g. `make install DESTDIR=$out PREFIX=`
|
||||
|
||||
`/etc` is sometimes in that `PREFIX` and sometimes not, be careful.
|
||||
|
||||
```txt
|
||||
$ fd -t f . --base-directory $out
|
||||
@@ -69,7 +71,7 @@ To ease most of the installation process there's several `make` recipes to insta
|
||||
|
||||
- `make` / `make lidm`: Builds the app binary.
|
||||
- `make install`: Attempts to install the binary, place a default config file in `/etc/lidm.ini` and install the man pages.
|
||||
- `make install-service-(systemd|dinit|runit|openrc|s6)(|-etc)`: Just check the source, service files for different init systems and `-etc` variants for alternative paths.
|
||||
- `make install-service-(systemd|dinit|runit|openrc|s6)(|-etc)`: Just check the source, service files for different init systems and `-etc` variants for alternative paths. You might need `FORCE=1` in the environment if you are packaging for other init system or scripting.
|
||||
- `make print-version`: Outputs the current version in the `Makefile` for scripts that might want to extract that info.
|
||||
|
||||
You can choose to use these packages or create your own service files / etc. There's are merely suggestions on what to use.
|
||||
|
||||
Reference in New Issue
Block a user