aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranklin Wei <git@fwei.tk>2015-05-30 22:56:19 -0400
committerFranklin Wei <git@fwei.tk>2015-05-30 22:56:19 -0400
commit970af9ba1b5228a5fd48cd7517557bc2857d28e8 (patch)
treea59b2484480a5c5309d5f3b9672dc7981f53c23c
parent66b21cea956483e2572a3dbbd596b6cbe314f04e (diff)
downloadmarket-sim-970af9ba1b5228a5fd48cd7517557bc2857d28e8.zip
market-sim-970af9ba1b5228a5fd48cd7517557bc2857d28e8.tar.gz
market-sim-970af9ba1b5228a5fd48cd7517557bc2857d28e8.tar.bz2
market-sim-970af9ba1b5228a5fd48cd7517557bc2857d28e8.tar.xz
readme update
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 83f9003..e27adc1 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,23 @@ A retro stock-trading game utilizing live data.
Made mostly for fun, there's a very slow, CGI-based demo version available [here](http://fwei.ml/market-sim.html).
+## Building
+
+### Prerequisites
+
+ - libcurl
+ - libcurses or equivalent (optional, see below)
+
+Just run:
+
+ make ; sudo make install
+
+This will install the market-sim binary in `/usr/local/bin`.
+
+### Building Without Curses Support
+
+Uncomment the `#define WITHOUT_CURSES` line in `src/globals.h`, then build as described above.
+
## About
Made with boredom and a cheaply bought keyboard.