aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArjun Satarkar <me@arjunsatarkar.net>2023-02-16 17:50:43 +0000
committerArjun Satarkar <me@arjunsatarkar.net>2023-02-16 17:50:43 +0000
commit754703844ba5ed118fe0d1858e61d1a203615454 (patch)
tree62a5e677ffbe57b0bb1d4c23a98cb197074c267d
parent842169b79b01cafdf0b804514c5673133029db73 (diff)
download8hash-754703844ba5ed118fe0d1858e61d1a203615454.tar
8hash-754703844ba5ed118fe0d1858e61d1a203615454.tar.gz
8hash-754703844ba5ed118fe0d1858e61d1a203615454.zip
Make readme Asciidoc
-rw-r--r--README.adoc (renamed from README.md)8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.adoc
index 369e7d6..c3dc35d 100644
--- a/README.md
+++ b/README.adoc
@@ -1,4 +1,4 @@
-# 8hash
+= 8hash
A consistent "magic 8-ball" that chooses the result based on a hash of the input string, so that it always returns the same result when given the same input (or fails to return a concrete answer).
@@ -6,17 +6,17 @@ Since the standard non-committal answers in a magic 8-ball indicate that you sho
We use the "djb2" hash function because of its simplicity.
-## Rationale
+== Rationale
It is somewhat strange that magic 8-balls, both physical and digital, can return opposite responses to the same question. At least in the digital case, we can mitigate this.
Of course, if you get an answer not to your liking, you can reword your query to try for a new one.
-## Usage and info
+== Usage and info
Run `./eight_hash.py` for interactive use, or `import eight_hash` to use as a library. We have to spell out eight because identifiers can't start with a number :(.
-## Copying
+== Copying
The author of this software is Arjun Satarkar.