summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorrealtradam <[email protected]>2020-11-21 10:37:06 -0500
committerrealtradam <[email protected]>2020-11-21 10:37:06 -0500
commit54357b58d880103417021d5992564436ea0e239f (patch)
tree44ddcaf88038a1f6dc997c80d62d8a9ac2c97e23
parent9b857a3871ca4960306cce175fa72ce2cc7ab13b (diff)
downloadcyberpunk-red-terminal-sheet-54357b58d880103417021d5992564436ea0e239f.tar.gz
cyberpunk-red-terminal-sheet-54357b58d880103417021d5992564436ea0e239f.zip
added readme
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..16164e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# CyberPunk Red Terminal Character Creator
+
+Lets you easily pick stats for your new character, while informing you what numbers, if any, are invalid. Also colours stats and skills based on if they have "high" values or "low" values
+
+## Sample image of what it looks like
+
+![image](https://imgur.com/BAOYRe0)
+
+## How to use
+
+1. Make sure to have ruby installed, with the [curses gem](https://github.com/ruby/curses)
+2. Clone this repo to wherever you please
+3. In the terminal, enter into the directory of this repo
+4. Simply execute the code with `ruby run.rb`
+5. Enjoy!
+
+## To do
+- [ ] Be able to load and save files