aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranklin Wei <git@fwei.tk>2015-05-30 23:02:59 -0400
committerFranklin Wei <git@fwei.tk>2015-05-30 23:02:59 -0400
commitac6edd6419aa25517a00a0f61ca344362d51fab6 (patch)
tree9ab8366425806c59a3da730e9de394abba5363af
parent970af9ba1b5228a5fd48cd7517557bc2857d28e8 (diff)
downloadmarket-sim-ac6edd6419aa25517a00a0f61ca344362d51fab6.zip
market-sim-ac6edd6419aa25517a00a0f61ca344362d51fab6.tar.gz
market-sim-ac6edd6419aa25517a00a0f61ca344362d51fab6.tar.bz2
market-sim-ac6edd6419aa25517a00a0f61ca344362d51fab6.tar.xz
tutorial for dummies
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index e27adc1..0620e1f 100644
--- a/README.md
+++ b/README.md
@@ -16,12 +16,28 @@ Just run:
make ; sudo make install
-This will install the market-sim binary in `/usr/local/bin`.
+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.
+## Basic Tutorial
+
+When you first run `market-sim`, an empty portfolio is created and you are given $1000 USD.
+
+1. You probably want to buy some shares now; type `buy`.
+
+ Enter the ticker symbol of the stock you wish to purchase:
+
+2. Input a ticker symbol.
+3. Enter the number of shares you wish to buy.
+4. Confirm the transaction. This will return you to the main prompt.
+5. From here, you probably want to save your porfolio to disk; type `write`.
+6. Enter the name of the file to save to. Careful, there's nothing to keep you from clobbering a file here!
+7. Come back later and trade some more shares!
+8. Profit.
+
## About
Made with boredom and a cheaply bought keyboard.