Initial commitmain

1 files changed, 35 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..5d89c24
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,35 @@
+REQUIREMENTS
+------------
+To run this script, you need:
+
+1. A POSIX-compliant shell
+2. The `zip` archiving utility installed in your PATH.
+3. A word list text file named `words.txt` containing one word per line,
+   placed in the same directory as the script.
+
+
+SETUP
+-----
+Make the script executable before running it:
+
+chmod +x csprdg.sh
+
+
+USAGE
+-----
+Ensure `words.txt` is in the same folder, then run the script:
+
+./csprdg.sh
+
+A document named `document.odt` will be generated in your current 
+working directory.
+
+
+LICENSE
+-------
+This project is licensed under either of:
+
+- Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
+- Zero-Clause BSD License (LICENSE-0BSD or https://opensource.org/license/0bsd)
+
+at your option.