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 3 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
40 changes: 27 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,18 @@ 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

```sh
sudo apt install \
lightdm \
gobject-introspection \
liblightdm-gobject \
liblightdm-gobject-dev \
libgirepository1.0-dev \
libcairo2 \
libcairo2-dev \
libxcb-dev \
libx11-dev
```
Sechorda marked this conversation as resolved.
Show resolved Hide resolved
## Installation

```sh
Expand All @@ -74,6 +76,12 @@ Also, you can package `build/unpacked` to whatever you want, like **.deb** with:

```sh
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.
```
Sechorda marked this conversation as resolved.
Show resolved Hide resolved

### Setting up with LightDM
Expand All @@ -89,6 +97,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/
Sechorda marked this conversation as resolved.
Show resolved Hide resolved

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 @@ -121,10 +135,10 @@ You can run the greeter from within your desktop session if you add the followin

You have to log out and log back in after adding that line. Then you can run the greeter from command line.

Themes can be opened with a debug console if you set `debug_mode` as `true` inside `/etc/lightdm/web-greeter.yml`. Or, you could run the `nody-greeter` with the parameter `--debug`. I recommend to use the last one, as it is easier and handy.
Themes can be opened with a debug console if you set `debug_mode` as `true` inside `/etc/lightdm/web-greeter.yml`. Or, you could run the `nody-greeter` with the parameter `--inspect`. I recommend to use the last one, as it is easier and handy.

```sh
nody-greeter --debug
nody-greeter --inspect
Sechorda marked this conversation as resolved.
Show resolved Hide resolved
```

Check `nody-greeter --help` for more commands.
Expand All @@ -136,7 +150,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