README: try new layout
This commit is contained in:
parent
e5d71e8e83
commit
7164bf1961
1 changed files with 20 additions and 12 deletions
32
README.md
32
README.md
|
@ -1,11 +1,15 @@
|
|||
## About
|
||||
<p align="left">
|
||||
<strong>Introduction</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.
|
||||
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.
|
||||
|
||||
## <a id='share/quran-json'>share/ directory</a>
|
||||
<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.
|
||||
|
@ -15,8 +19,6 @@ the JSON format.
|
|||
* [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.
|
||||
|
||||
### JSON layout
|
||||
|
||||
The
|
||||
[share/quran-json/TheQuran](share/quran-json/TheQuran/)
|
||||
directory contains multiple sub-directories, where each sub-directory represents
|
||||
|
@ -31,19 +33,23 @@ content of the ayah.
|
|||
|
||||
See [Surah Al-Fatihah (English)](share/quran-json/TheQuran/en/1.json) for an example.
|
||||
|
||||
## <a id='bin/quran-json'>bin/ directory</a>
|
||||
<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*
|
||||
|
||||
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 Only update the surah metadata (implies -r, default: no)
|
||||
|
||||
## Thanks
|
||||
<p align="left">
|
||||
<strong>Thanks</strong>
|
||||
</p>
|
||||
|
||||
First and foremost, Alhamdulillah.
|
||||
|
||||
|
@ -60,7 +66,9 @@ And thanks to the translators of the content:
|
|||
* _Muhammad Hamidullah_ for the French translation.
|
||||
* _Hamza Roberto Piccardo_ for the Italian translation.
|
||||
|
||||
## License
|
||||
<p align="left">
|
||||
<strong>License</strong>
|
||||
</p>
|
||||
|
||||
The "source code" is released under the [BSD0L](./LICENSE) license.
|
||||
<br>
|
||||
|
|
Loading…
Reference in a new issue