0x1eef
3f1ed58432
I came across the pattern in this diff while browsing the [rake](https://github.com/ruby/rake/) source code, and I thought it was worth repeating in quran-json.
76 lines
3.1 KiB
Markdown
76 lines
3.1 KiB
Markdown
<p align="left">
|
|
<strong>About</strong>
|
|
</p>
|
|
|
|
quran-json is a dual purpose project where on the one hand it provides a
|
|
utility for downloading the content of The Quran in multiple languages, and on
|
|
the other hand it provides a copy of the content that can be downloaded. The
|
|
content is provided in the JSON format.
|
|
|
|
<p align="left">
|
|
<strong>share/</strong>
|
|
</p>
|
|
|
|
* [share/quran-json/TheQuran/ar/](share/quran-json/TheQuran/ar/) contains The Quran in its original Arabic.
|
|
* [share/quran-json/TheQuran/en/](share/quran-json/TheQuran/en/) contains an English translation of The Quran.
|
|
* [share/quran-json/TheQuran/fa/](share/quran-json/TheQuran/fa/) contains a Farsi translation of The Quran.
|
|
* [share/quran-json/TheQuran/pt/](share/quran-json/TheQuran/pt/) contains a Portuguese translation of The Quran.
|
|
* [share/quran-json/TheQuran/nl/](share/quran-json/TheQuran/nl/) contains a Dutch translation of The Quran.
|
|
* [share/quran-json/TheQuran/fr/](share/quran-json/TheQuran/fr/) contains a French translation of The Quran.
|
|
* [share/quran-json/TheQuran/it/](share/quran-json/TheQuran/it/) contains an Italian translation of The Quran.
|
|
|
|
The
|
|
[share/quran-json/TheQuran](share/quran-json/TheQuran/)
|
|
directory contains multiple sub-directories, where each sub-directory represents
|
|
a locale (eg `en` for English, `ar` for Arabic, and so on). Within each sub-directory,
|
|
there is a JSON file for each surah (also known as a chapter).
|
|
|
|
The structure of each JSON file can be described as an array where the first element is
|
|
an object that contains information about a surah, and the rest of the array contains
|
|
the content of the surah. The content is composed of two-element arrays - where the first
|
|
element is the ayah number (also known as a verse number), and the second element is the
|
|
content of the ayah.
|
|
|
|
See [Surah Al-Fatihah (English)](share/quran-json/TheQuran/en/1.json) for an example.
|
|
|
|
<p align=left">
|
|
<strong>bin/</strong>
|
|
</p>
|
|
|
|
The [bin/quran-json](bin/quran-json) executable is a utility for downloading
|
|
the content of The Quran in multiple languages.
|
|
|
|
*Usage*
|
|
|
|
Usage: quran-json pull [OPTIONS]
|
|
-l, --locale LOCALE ar, en, pt, fa, nl, fr, or it (default: en)
|
|
-r, --replace Replace existing JSON files (default: no)
|
|
-u, --update Replace surah metadata with an updated copy (implies -r, default: no)
|
|
|
|
|
|
<p align="left">
|
|
<strong>Thanks</strong>
|
|
</p>
|
|
|
|
First and foremost, Alhamdulillah.
|
|
|
|
Thanks to the following websites for providing the downloadable content:
|
|
|
|
* https://searchtruth.com for the original Arabic, and the Italian translation.
|
|
* https://quran.com for the English, Farsi, Portuguese, Dutch, and French translations.
|
|
|
|
And sincere thanks to the translators of the content:
|
|
|
|
* _Dr. Mustafa Khattab_ for the English translation.
|
|
* _Hussein Taji Kal Dari_ for the Farsi translation.
|
|
* _Sofian S. Siregar_ for the Dutch translation.
|
|
* _Muhammad Hamidullah_ for the French translation.
|
|
* _Hamza Roberto Piccardo_ for the Italian translation.
|
|
|
|
<p align="left">
|
|
<strong>License</strong>
|
|
</p>
|
|
|
|
The "source code" is released under the [GPL](./LICENSE) license.
|
|
<br>
|
|
The content is copyrighted to the translators (listed above).
|