Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add installation instructions to readme #15

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

Merged
merged 3 commits into from
Jan 7, 2020
Merged

Add installation instructions to readme #15

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
872a76a
adjust README header
rramphal Sep 3, 2018
25acb11
added installation instructions to the README and combined them with …
rramphal Sep 3, 2018
91c9a2c
added copy instructions to README
rramphal Sep 3, 2018
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
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Open a notification in the top-right corner of your screen and display a "Reply"
## Actions alert
Open a notification in the top-right corner of your screen and display one or more actions to click on.

# Features
## Features
* set alert's icon, title, subtitle, image.
* capture text typed by user in the reply type alert.
* timeout : automatically close the alert notification after a delay.
Expand All @@ -24,10 +24,24 @@ Open a notification in the top-right corner of your screen and display one or mo
* value or json output on alert's event (closed, timeout, replied, activated...)
* close the alert notification on SIGINT, SIGTERM.

## Download
## Installation

Prebuilt binaries are available from the
1. Download the zipped precompiled binary from the
[releases section](https://github.com/vjeantet/alerter/releases).
2. Extract the binary.
3. Use as described below.

### Adding to `$PATH`

If you don't want to have to specify the absolute/relative path to the binary, you can place the binary in any directory that is listed in your `$PATH` so that your system can automatically find it.

If you would like to see which directories are currently in your `$PATH`, you can run `echo $PATH`.

You can use the `cp` command to copy the binary to your chosen directory. For example:

```shell
cp ~/Downloads/alerter /path/to/directory/you/choose/
```

## Usage

Expand Down