diff --git a/README.md b/README.md index 32799d2..7dae5e1 100644 --- a/README.md +++ b/README.md @@ -274,19 +274,23 @@ en 10 5 He is the One Who made the sun a radiant source and the The [bin/](bin/) directory contains scripts that generate the contents of the [src/](src/) directory: - * [bin/pull-arabic](bin/pull-arabic)
+* JSON scripts + + * [bin/json/pull-arabic](bin/json/pull-arabic)
This script is responsible for populating [src/json/ar/](src/json/ar/). - * [bin/pull-english](bin/pull-english)
+ * [bin/json/pull-english](bin/json/pull-english)
This script is responsible for populating [src/json/en/](src/json/en/). - * [bin/pull-farsi](bin/pull-farsi)
+ * [bin/json/pull-farsi](bin/json/pull-farsi)
This script is responsible for populating [src/json/fa/](src/json/fa/). - * [bin/pull-portuguese](bin/pull-portuguese)
+ * [bin/json/pull-portuguese](bin/json/pull-portuguese)
This script is responsible for populating [src/json/pt/](src/json/pt/). - * [bin/create-sql-seed-file](bin/create-sql-seed-file)
+* SQL scripts + + * [bin/sql/create-sql-seed-file](bin/sql/create-sql-seed-file)
This script creates [src/sql/seed.sql](src/sql/seed.sql), and uses the contents of [src/json/](src/json/) to do so. @@ -299,8 +303,8 @@ the repository already. **Note #2** The scripts are written in [Ruby v3.1.0+](https://www.ruby-lang.org).
-The ["pull-english"](bin/pull-english), ["pull-farsi"](bin/pull-farsi) and -["pull-portuguese"](bin/pull-portuguese) scripts depend on the ["pull-arabic"](bin/pull-arabic) +The ["pull-english"](bin/json/pull-english), ["pull-farsi"](bin/json/pull-farsi) and +["pull-portuguese"](bin/json/pull-portuguese) scripts depend on the ["pull-arabic"](bin/json/pull-arabic) script being run first. The script dependencies can be installed by running `gem install -g gem.deps.rb` from the root of the repository. ## Download diff --git a/bin/pull-arabic b/bin/json/pull-arabic similarity index 100% rename from bin/pull-arabic rename to bin/json/pull-arabic diff --git a/bin/pull-english b/bin/json/pull-english similarity index 100% rename from bin/pull-english rename to bin/json/pull-english diff --git a/bin/pull-farsi b/bin/json/pull-farsi similarity index 100% rename from bin/pull-farsi rename to bin/json/pull-farsi diff --git a/bin/pull-portuguese b/bin/json/pull-portuguese similarity index 100% rename from bin/pull-portuguese rename to bin/json/pull-portuguese diff --git a/bin/create-sql-seed-file b/bin/sql/create-sql-seed-file similarity index 100% rename from bin/create-sql-seed-file rename to bin/sql/create-sql-seed-file