Upload Jin Xiongrong's work -- https://gitee.com/dragondove/storode; fix UnicodeDecodeError

1 files changed, 22 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8344f39
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Cross-referencing code and requirement
+---
+
+Example for generating identifier for requirements from user stories:
+
+```bash
+# Try to delete ./example/srs_with_id.txt and then run this command
+python ./src/storode.py ./example/srs.txt
+```
+
+Example for generating web pages:
+
+```bash
+# Try to delete ./doc and run this command
+python ./src/storode.py ./example/srs_with_id.txt ./example/src
+```
+
+Example for testing collision rate of cut of MD5 digest:
+
+```bash
+python ./src/collision.py
+```