added macOS instructions

This commit is contained in:
Bryson Steck 2022-03-25 23:09:18 -06:00
parent d46ba98831
commit 40ef9f33ba
3 changed files with 26 additions and 1 deletions

View file

@ -4,6 +4,7 @@ Installation
Instructions are available for the following operating systems:
* `Linux/BSD <#linuxbsd>`_
* `macOS <#macos>`_
* `Windows <#windows>`_
Linux/BSD
@ -85,6 +86,27 @@ Other Linux/UNIX-based systems
-------------------------------
If you fit this category, you probably know what you need to build ``uirc``.
macOS
======
To build ``uirc`` on macOS, make sure `brew <https://brew.sh>`_ and the Xcode Command Line tools (run ``xcode-select --install`` to make sure) are installed, then follow the instructions below.
.. code:: bash
% brew install curl wget
% git clone https://github.com/brysonsteck/uirc && cd uirc
You will also need to uncomment the INCLUDE_PREFIX line at the top of the `config.mk <config.mk>`_ file to make sure that the stb library is downloaded correctly.
.. code:: bash
# in macOS, you must install the 'stb' library manually from GitHub. do this with:
% make stb
# build uirc with:
% make
# or, if you want to install globally, use:
% make install
Windows
========

View file

@ -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/
wget https://raw.githubusercontent.com/nothings/stb/master/stb_image.h -P ${INCLUDE_PREFIX}/stb
.PHONY: uirc install stb

View file

@ -2,6 +2,9 @@
PREFIX = /usr/local/bin
LIB_PREFIX = ${PREFIX}/lib
INCLUDE_PREFIX = /usr/include
# comment the line above and uncomment the following line
# if you are building on macOS, otherwise it is optional
#INCLUDE_PREFIX = /usr/local/include
# manual install location
MANPREFIX = ${PREFIX}/share/man