Browse Source

Updated README

sisyphus
JezerM 4 years ago
parent
commit
64488d6d84
  1. 64
      README.md

64
README.md

@ -1,66 +1,44 @@
# Web Greeter for LightDM
[![Latest Release][release]](https://github.com/Antergos/web-greeter/releases)  [![Codacy Grade][codacy]](https://www.codacy.com/app/Antergos/web-greeter)  [![CircleCI][circleci]](https://circleci.com/gh/Antergos/web-greeter)  [![Theme API Docs][api]](https://doclets.io/Antergos/web-greeter/stable)  [![AUR Votes][aur]](https://aur.archlinux.org/packages/lightdm-webkit2-greeter)
## Install It
This is a try to update the [Antergos web-greeter](https://github.com/Antergos/web-greeter), following what they left, so all the credits should go with them.
### Distro Packages
|Distro|Install Command/Links|
|:---:|:---:|
|![antergos][antergos]|`sudo pacman -S lightdm-webkit2-greeter`|
|![arch][arch] |`yaourt -S lightdm-webkit2-greeter`|
|![fedora][fedora] |`dnf copr enable antergos/lightdm-webkit2-greeter`|
|![openSUSE][openSUSE]|[1 Click Install](https://software.opensuse.org/ymp/home:antergos/openSUSE_Leap_42.2/lightdm-webkit2-greeter.ymp?base=openSUSE%3ALeap%3A42.2&query=lightdm-webkit2-greeter)|
|![ubuntu][ubuntu] |[OBS Repo](https://software.opensuse.org/download.html?project=home:antergos&package=lightdm-webkit2-greeter)|
As this is based on the [master release](https://github.com/Antergos/web-greeter/tree/master), which does some API changes, actual themes would need to do changes to work correctly.
### From Source
#### Dependencies
| | ![antergos][antergos]    ![arch][arch] | ![ubuntu][ubuntu] | ![fedora][fedora] | ![openSUSE][openSUSE] |
|-----------------------|--------------------------------------------------|----------------------|---------------------|-----------------------|
|**[whither][whither]** |python-whither |python3-whither |python3-whither |python3-whither |
## Dependencies
| | arch | ubuntu | fedora | openSUSE |
|-----------------------|---------------|----------------------|---------------------|-----------------------|
|**[whither][whither]** | \*install it from source\*
|**liblightdm-gobject** |lightdm |liblightdm-gobject-dev|lightdm-gobject-devel|liblightdm-gobject-1-0 |
|**pygobject** |python-gobject |python3-gi |pygobject3 |python3-gobject |
> ***NOTE*** Be sure to have [whither][whither] installed from this source
> ***NOTE:*** These instructions are for the `master` branch. To build the latest release, please see the `stable` branch.
### PIP
You can install the above dependencies with pip. **liblightdm-gobject** should be accesible if you have installed lightdm.
```sh
pip install PyGObject
```
#### Download & Install
## Download & Install
```sh
git clone https://github.com/Antergos/web-greeter.git /tmp/greeter
cd /tmp/greeter
git clone https://github.com/JezerM/web-greeter.git
cd web-greeter
sudo make install
```
## Theme JavaScript API
The greeter exposes a JavaScript API to themes which they must use to interact with the greeter (in order to facilitate the user login process). For more details, check out the [API Documentation](https://doclets.io/Antergos/web-greeter/stable).
## Theme Javascript API
[Antergos](https://github.com/Antergos) documentation is no longer available. Although, you can see the man-pages `man web-greeter` for some documentation and explanation. Also, you can explore the provided [themes](./themes) for real use cases.
## Debugging
You can run the greeter from within your desktop session if you add the following line to the desktop file for your session located in `/usr/share/xsessions/`: `X-LightDM-Allow-Greeter=true`.
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 `web-greeter` with the parameter `--debug`. I recommend to use the last one, as it is easier and handy.
```sh
web-greeter
web-greeter --debug
```
Themes can be opened with a debug console if you set `debug_mode` to `true` inside `/etc/lightdm/web-greeter.yml`.
> ***Note:*** Do not use `lightdm --test-mode` as it is not supported.
## Translations
Translations are managed through [Transifex](https://www.transifex.com/faidoc/antergos/lightdm-webkit2-greeter/).
[antergos]: https://antergos.com/distro-logos/logo-square26x26.png "antergos"
[arch]: https://antergos.com/distro-logos/archlogo26x26.png "arch"
[fedora]: https://antergos.com/distro-logos/fedora-logo.png "fedora"
[openSUSE]: https://antergos.com/distro-logos/Geeko-button-bling7.png "openSUSE"
[ubuntu]: https://antergos.com/distro-logos/ubuntu_orange_hex.png "ubuntu"
[debian]: https://antergos.com/distro-logos/openlogo-nd-25.png "debian"
[release]: https://img.shields.io/github/release/Antergos/web-greeter.svg?style=flat-square "Latest Release"
[codacy]: https://img.shields.io/codacy/grade/43c95c8c0e3749b8afa3bfd2b6edf541.svg?style=flat-square "Codacy Grade"
[circleci]: https://img.shields.io/circleci/project/Antergos/web-greeter/master.svg?style=flat-square "CI Status"
[api]: https://img.shields.io/badge/API--Docs-ready-brightgreen.svg?style=flat-square "Theme API Docs"
[aur]: https://img.shields.io/aur/votes/lightdm-webkit2-greeter.svg?maxAge=604800&style=flat-square "AUR Votes"
[whither]: https://github.com/Antergos/whither "Whither"
[whither]: https://github.com/JezerM/whither "Whither"

Loading…
Cancel
Save