From 0b67f67440bf540ca4191f59087a987f127a1f9b Mon Sep 17 00:00:00 2001 From: patrick96 Date: Thu, 26 Nov 2020 20:14:57 +0100 Subject: [PATCH] readme: Move installation instructions to wiki All the information in the README was already duplicated on the wiki, it makes sense to keep the README small and point the user to the wiki. --- README.md | 62 ++++++------------------------------------------------- 1 file changed, 6 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index c5e1977e..daee2e6d 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,7 @@ Make sure you include steps on how to reproduce it. * [Introduction](#introduction) * [Getting Help](#getting-help) * [Getting started](#getting-started) - * [Dependencies](#dependencies) - * [Building from source](#building-from-source) + * [Installation](#installation) * [Configuration](#configuration) * [Running](#running) * [Community](#community) @@ -85,11 +84,9 @@ If you find yourself stuck, have a look at our [Support](SUPPORT.md) page for re Polybar was already packaged for the distros listed below. -If you can't find your distro here, you will have to [build from source](#building-from-source). +If you can't find your distro here, you will have to [build from source](https://github.com/polybar/polybar/wiki/Compiling). -If you create a package for any other distribution, please consider contributing the template. - -If you are using **Debian** (unstable or testing), you can install [polybar](https://tracker.debian.org/pkg/polybar) using `sudo apt install polybar`. +If you are using **Debian** (unstable or testing), you can install [polybar](https://tracker.debian.org/pkg/polybar) using `sudo apt install polybar`. If you are using **Debian** (buster/stable), you need to enable [backports](https://wiki.debian.org/Backports) and then install using `sudo apt -t buster-backports install polybar`. If you are using **Arch Linux**, you can install the AUR package [polybar-git](https://aur.archlinux.org/packages/polybar-git/) to get the latest version, or @@ -111,57 +108,10 @@ If you are using **Gentoo**, both release and git-master versions are available If you are using **Fedora**, you can install [polybar](https://src.fedoraproject.org/rpms/polybar) using `sudo dnf install polybar`. -### Dependencies +### Installation -A compiler with C++14 support ([clang-3.4+](https://llvm.org/releases/download.html), [gcc-5.1+](https://gcc.gnu.org/releases.html)), [cmake 3.1+](https://cmake.org/download/), [git](https://git-scm.com/downloads) -- `cairo` -- `libxcb` -- `python` -- `xcb-proto` -- `xcb-util-image` -- `xcb-util-wm` - -**Optional dependencies:** -- `xcb-util-cursor` *required for the `cursor-click` and `cursor-scroll` settings* -- `xcb-util-xrm` *required for accessing X resources with `${xrdb:...}`* - -**Optional dependencies for extended module support:** -- `xcb-xkb` *required by `internal/xkeyboard`* -- `alsa-lib` *required by `internal/alsa`* -- `libpulse` *required by `internal/pulseaudio`* -- `i3-wm` *required by `internal/i3`* -- `jsoncpp` *required by `internal/i3`* -- `libmpdclient` *required by `internal/mpd`* -- `libcurl` *required by `internal/github`* -- `libnl-genl` or `wireless_tools` *required by `internal/network`* - -Find a more complete list on the [dedicated wiki page](https://github.com/polybar/polybar/wiki/Compiling). - - -### Building from source - -Please [report any problems](https://github.com/polybar/polybar/issues/new/choose) you run into when building the project. - -Download the `polybar-.tar` for the version you want to build from the -[release page](https://github.com/polybar/polybar/releases), extract it with -`tar xvf polybar-.tar` and go into the extracted folder. There, run -the following commands: - -```sh -$ mkdir build -$ cd build -$ cmake .. -$ make -j$(nproc) -$ sudo make install -``` - -There's also a helper script available in the root folder: - - ~~~ sh - $ ./build.sh - ~~~ - -For more info, have a look at the [Compiling wiki page](https://github.com/polybar/polybar/wiki/Compiling). +The [compiling page](https://github.com/polybar/polybar/wiki/Compiling) on the +wiki describes all steps necessary to build and install polybar. ### Configuration