From f035426e7f239a414f89159f4810f762c98cd37f Mon Sep 17 00:00:00 2001 From: Bryson Steck Date: Sat, 12 Mar 2022 22:42:44 -0700 Subject: updated readme, simplified make --- README.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 70f79ca..d85285e 100644 --- a/README.rst +++ b/README.rst @@ -32,6 +32,14 @@ I've made my decision. How do I install? Ah, the UNIX community. Stubborn about always wanting to use command line tools over convenience. It just warms my heart. -In order to install, you must have ``make`` (installed on basically all \*nix systems) or another compatible tool installed. Then, simply run:: +In order to build ``uirc``, you must have ``make`` or another compatible tool for Makefiles installed. You will also need the Public Domain ``stb`` header files, all of which can be installed through your system's package manager. You also can manually install the single header file ``uirc`` needs if you don't want the other headers. You can do this by running:: + + $ make stb + +Once the headers are installed, you can simply run this command to make the binary:: + + $ make + +Or, if you would like to install ``uirc`` to your system globally, run:: $ make install -- cgit v1.2.3