diff options
| -rw-r--r-- | INSTALL.rst | 48 | ||||
| -rw-r--r-- | Makefile | 2 |
2 files changed, 43 insertions, 7 deletions
diff --git a/INSTALL.rst b/INSTALL.rst index 64ab3e5..ffac132 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -13,28 +13,64 @@ Debian/Debian-based (Ubuntu, Pop!_OS, etc.) -------------------------------------- .. code:: bash - $ sudo apt install git libcurl3-gnutls libstb-dev + $ sudo apt install git gcc libcurl3-gnutls libstb-dev + $ git clone https://github.com/brysonsteck/uirc && cd uirc + # build uirc with: + $ make + # or, if you want to install globally, use: + $ sudo make install RHEL-based (Fedora, CentOS, etc.) ---------------------------------- .. code:: bash - $ sudo dnf install git + $ sudo dnf install git gcc libcurl-devel stb-devel + $ git clone https://github.com/brysonsteck/uirc && cd uirc + # build uirc with: + $ make + # or, if you want to install globally, use: + $ sudo make install OpenSUSE --------- .. code:: bash - $ sudo zypper install + $ sudo zypper install git gcc libcurl-devel stb-devel + $ git clone https://github.com/brysonsteck/uirc && cd uirc + # build uirc with: + $ make + # or, if you want to install globally, use: + $ sudo make install Arch/Arch-based (Manjaro, EndeavourOS, etc.) --------------------------------------------- .. code:: bash - $ sudo pacman -S + # 'stb' is an AUR package and must be installed with an AUR helper, such as 'yay'. + $ yay -S git gcc libcurl-gnutls stb + $ git clone https://github.com/brysonsteck/uirc && cd uirc + # build uirc with: + $ make + # or, if you want to install globally, use: + $ sudo make install FreeBSD/OpenBSD ---------------- -.. code:: fish +.. code:: bash + + $ doas pkg_add git curl + # in BSD, you must install the 'stb' library manually from GitHub. + # in order to do this, make sure wget is installed with: + $ doas pkg_add wget + # then, clone the repository and install the 'stb' library: + $ git clone https://github.com/brysonsteck/uirc && cd uirc + $ doas make stb + +To build ``uirc`` on BSD, you need to uncomment the OPTIONS line at the bottom of the `config.mk <config.mk>`_ file. Additionally, if you would rather use ``cc`` instead of ``gcc``, you can change that in this file as well. Then, you can continue with the instructions. + +.. code:: bash - $ doas pkg_add + # build uirc with: + $ make + # or, if you want to install globally, use: + $ doas make install @@ -26,6 +26,6 @@ stb: @echo "Press ENTER to manually install the stb headers needed instead. Otherwise, quit with ^C" @read mkdir -p ${INCLUDE_PREFIX}/stb - wget https://raw.githubusercontent.com/nothings/stb/master/stb_image.h -P /usr/include/stb/stb_image.h + wget https://raw.githubusercontent.com/nothings/stb/master/stb_image.h -P /usr/include/stb/ .PHONY: uirc install stb |