brysonsteck/uirc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added wsl instructions

Browse source
This commit is contained in:
Bryson Steck 2022-03-24 15:45:27 -06:00
parent 9644d1b8fa
commit bf0d21d97d
1 changed files with 20 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
INSTALL.rst
View file

@ -1,6 +1,13 @@
Installation Installation
============= =============
Instructions are available for the following operating systems:
* `Linux/BSD <#linuxbsd>`_
* `Windows <#windows>`_
Linux/BSD
==========
To install ``uirc``, you need to have the following items: To install ``uirc``, you need to have the following items:
* A C compiler (``uirc`` uses ``gcc`` by default, but you can change what compiler you use in the `config.mk file <config.mk>`_.) * A C compiler (``uirc`` uses ``gcc`` by default, but you can change what compiler you use in the `config.mk file <config.mk>`_.)
@ -58,12 +65,10 @@ FreeBSD/OpenBSD
---------------- ----------------
.. code:: bash .. code:: bash
$ doas pkg_add git curl $ doas pkg_add git curl wget
# 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: # then, clone the repository and install the 'stb' library:
$ git clone https://github.com/brysonsteck/uirc && cd uirc $ git clone https://github.com/brysonsteck/uirc && cd uirc
# in BSD, you must install the 'stb' library manually from GitHub. do this with:
$ doas make stb $ 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. 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.
@ -74,3 +79,14 @@ To build ``uirc`` on BSD, you need to uncomment the OPTIONS line at the bottom o
$ make $ make
# or, if you want to install globally, use: # or, if you want to install globally, use:
$ doas make install $ doas make install
Windows
========
To build on Windows, you need to install a Linux distribution through WSL. This can be done with the following command in Command Prompt::
>wsl --install
Once installed and you set up your user account, run ``sudo apt update && sudo apt upgrade`` and confirm to install the updates. Let it sit here, this might take a while.
Once you have updated your WSL instance, read the `Linux <#linuxbsd>`_ section above, following instructions for your WSL distribution (if you followed this guide to install, you will be following instructions for Debian).