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: add install section #394

Merged
merged 2 commits into from
Dec 28, 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
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,21 @@ Now, scrot is maintained by volunteers under [Resurrecting Open Source Projects]

If you are interested in helping scrot, read the [CONTRIBUTING.md](CONTRIBUTING.md) file.

## Installing ##

scrot is available in the official repository of many linux/BSD distributions.
It is recommended to use the system package manager for installing scrot.
For example, Debian users can run the following command to install scrot:

```console
$ sudo apt install scrot
```

A list of repositories that package scrot is
[available here](https://repology.org/project/scrot/versions).
If your distribution does not package scrot, you may also build scrot from
source by following the build instructions below.

## Building ##

This section describes the steps to build and install scrot.
Expand Down Expand Up @@ -94,11 +109,6 @@ You can return to a pristine source tree before running `./configure`:
$ ./autogen.sh clean
```

Debian users can install scrot from their package manager:
```console
$ sudo apt install scrot
```

Bash and Zsh completion scripts are available in [etc/](./etc).
Distro packagers are encouraged to install them to the appropriate directory.

Expand Down
Loading