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.

Sign up for GitHub

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

Update README.md #961

Open
wants to merge 1 commit into
base: beta
Choose a base branch
from
Open

Update README.md #961

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@

Howdy provides Windows Hello™ style authentication for Linux. Use your built-in IR emitters and camera in combination with facial recognition to prove who you are.

Using the central authentication system (PAM), this works everywhere you would otherwise need your password: Login, lock screen, sudo, su, etc.
Using the central authentication system (PAM) works in place of a password such as Login, lock screen, sudo, su, etc.

## Installation

Howdy is currently available and packaged for Debian/Ubuntu, Arch Linux, Fedora and openSUSE. If you’re interested in packaging Howdy for your distro, don’t hesitate to open an issue.
Howdy is currently available and packaged for Debian/Ubuntu, Arch Linux, Fedora, and openSUSE. To use Howdy for your distro, open an issue.

**Note:** The build of dlib can hang on 100% for over a minute, give it time.
**Note:** The build of Idlib can hang on 100% for over a minute; give it time.

### Ubuntu or Linux Mint

Expand All @@ -42,7 +42,7 @@ This will guide you through the installation.

### Debian

Download the .deb file from the [Releases page](https://github.com/boltgolt/howdy/releases) and install with gdebi.
Download the .deb file from the [Releases page](https://github.com/boltgolt/howdy/releases) and install it with `gdebi`.

### Arch Linux

Expand All @@ -56,7 +56,7 @@ You will need to do some additional configuration steps. Please read the [ArchWi

_Maintainer: [@luyatshimbalanga](https://github.com/luyatshimbalanga)_

The `howdy` package is available as a [Fedora COPR repository](https://copr.fedorainfracloud.org/coprs/principis/howdy/), install it by simply executing the following commands in a terminal:
The `howdy` package is available as a [Fedora COPR repository](https://copr.fedorainfracloud.org/coprs/principis/howdy/). Install it by simply executing the following commands in a terminal:

```
sudo dnf copr enable principis/howdy
Expand All @@ -73,7 +73,7 @@ Go to the [openSUSE wiki page](https://en.opensuse.org/SDB:Facial_authentication

### Building from source

If you want to build Howdy from source, a few dependencies are required.
If you want to build Howdy from the source, a few dependencies are required.

#### Dependencies

Expand All @@ -86,7 +86,7 @@ If you want to build Howdy from source, a few dependencies are required.
- INIReader (can be pulled from git automatically if not found)
- libevdev

To install them on Debian/Ubuntu for example:
To install them on Debian/Ubuntu, for example:

```
sudo apt-get update && sudo apt-get install -y \
Expand All @@ -103,15 +103,15 @@ meson setup build
meson compile -C build
```

You can also install Howdy to your system with `meson install -C build`.
You can also install Howdy on your system with `meson install -C build.`

## Setup

After installation, Howdy needs to learn what you look like so it can recognise you later. Run `sudo howdy add` to add a face model.
After installation, Howdy needs to learn what you look like so it can recognize you later. Run `sudo howdy add` to add a face model.

If nothing went wrong we should be able to run sudo by just showing your face. Open a new terminal and run `sudo -i` to see it in action. Please check [this wiki page](https://github.com/boltgolt/howdy/wiki/Common-issues) if you're experiencing problems or [search](https://github.com/boltgolt/howdy/issues) for similar issues.

If you're curious you can run `sudo howdy config` to open the central config file and see the options Howdy has to offer. On most systems this will open the nano editor, where you have to press `ctrl`+`x` to save your changes.
If you're curious, you can run `sudo howdy config` to open the central config file and see the options Howdy offers. On most systems this will open the nano editor, where you must press `ctrl`+`x` to save your changes.

## CLI

Expand All @@ -136,7 +136,7 @@ howdy [-U user] [-y] command [argument]

## Contributing [![](https://img.shields.io/travis/boltgolt/howdy/dev.svg?label=dev%20build)](https://github.com/boltgolt/howdy/tree/dev) [![](https://img.shields.io/github/issues-raw/boltgolt/howdy/enhancement.svg?label=feature+requests&colorB=4c1)](https://github.com/boltgolt/howdy/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)

The easiest ways to contribute to Howdy is by starring the repository and opening GitHub issues for features you'd like to see. If you want to do more, you can also [buy me a coffee](https://www.buymeacoffee.com/boltgolt).
The easiest way to contribute to Howdy is by starring the repository and opening GitHub issues for features you'd like to see. If you want to do more, you can also [buy me a coffee](https://www.buymeacoffee.com/boltgolt).

Code contributions are also very welcome. If you want to port Howdy to another distro, feel free to open an issue for that too.

Expand All @@ -149,7 +149,7 @@ if you encounter an error that hasn't been reported yet, don't be afraid to open

## A note on security

This package is in no way as secure as a password and will never be. Although it's harder to fool than normal face recognition, a person who looks similar to you, or a well-printed photo of you could be enough to do it. Howdy is a more quick and convenient way of logging in, not a more secure one.
This package is not as secure as a password and will never be. Although it's harder to fool than normal face recognition, a person who looks similar to you, or a well-printed photo of you could be enough to do it. Howdy is a more quick and convenient way of logging in, not a more secure one.

To minimize the chance of this program being compromised, it's recommended to leave Howdy in `/lib/security` and to keep it read-only.

Expand Down