Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README updates #56

Merged
merged 7 commits into from
Sep 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,7 @@ Themes working in **web-greeter** should work also here. All themes shipped with

### Common dependencies

- lightdm (as obvious)
- gobject-introspection
- liblightdm-gobject
- liblightdm-gobject-dev
- libgirepository1.0-dev
- libcairo2
- libcairo2-dev
- libxcb-dev
- libx11-dev
`lightdm gobject-introspection liblightdm-gobject-1-0 liblightdm-gobject-dev libgirepository1.0-dev libcairo2 libcairo2-dev libxcb1-dev libx11-dev`

## Installation

Expand All @@ -76,6 +68,13 @@ Also, you can package `build/unpacked` to whatever you want, like **.deb** with:
dpkg-deb --root-owner-group --build unpacked
```

> [!NOTE]
> For Debian systems:
>
> 1. Copy build/DEBIAN/ to build/unpacked
> 2. In the control file, replace the liblightdm-gobject-1-dev dependency with liblightdm-gobject-dev.
> the liblightdm-gobject-1-dev package only exists in Ubuntu, the Debian equivalent is liblightdm-gobject-dev.

### Setting up with LightDM

Inside `/etc/lightdm/lightdm.conf`, below a Seat configuration, add:
Expand All @@ -89,6 +88,12 @@ Afterwards, restart the lightdm service.
> [!CAUTION]
> Be sure that nody-greeter works before restarting lightdm

### Installing Themes

All themes must be installed at `/usr/share/web-greeter/themes/`

View community themes: https://web-greeter-page.vercel.app/themes

## Theme JavaScript API

To create themes for nody-greeter and web-greeter, check the documentation available at [web-greeter-docs][web-greeter-docs].
Expand Down Expand Up @@ -136,7 +141,7 @@ Check `nody-greeter --help` for more commands.

### node-gyp fails on `npm run rebuild`

> Supported Node.js versions: 16, 18 (other versions should work but are untested)
> Supported Node.js versions: 16, 18, 20, 22.

### Issues with distutils

Expand Down
Loading