aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulian Hurst <ark@mansus.space>2024-09-17 11:34:40 +0200
committerJulian Hurst <ark@mansus.space>2024-09-17 11:36:02 +0200
commit06489df37cf2d15385eac3cdcc8e18330f3b714b (patch)
treed3392765acaf181df1cfa652a8d8f91b25f86c64
parent90ae5b6c3a44a57136b028641b18e572683af96f (diff)
downloadrng-06489df37cf2d15385eac3cdcc8e18330f3b714b.tar.gz
Add readme
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f97fbef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# rng
+Generates pseudorandom numbers
+
+## Usage
+
+ ./rng: Random Number Generator
+
+ Usage: ./rng [-hsd] [-n <number>] [-m <max>] [-S <separator>]
+
+ -h: print this help text
+ -n <number>: Number of random numbers to print (default: 6)
+ -m <max>: Max number than can be generated (default: 110)
+ -S <separator>: The separator to use when displaying the numbers (default: \n)
+ -s: Sort the numbers
+ -d: Avoid duplicates
+
+## Build
+
+To build, install [hare](https://harelang.org) and run:
+
+ $ hare build rng.ha