diff --git a/README.md b/README.md index aa16fad..d71c62f 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,6 @@ in English, Farsi, and Portuguese. The contents are made available in JSON, and This section covers the JSON files. Click [here](#srcsql-directory) to jump to the SQL section. -* The [src/json/chapter-metadata.json](src/json/chapter-metadata.json) file contains information - about each chapter in The Qur'an. - * The [src/json/ar/](src/json/ar/) directory contains The Qur'an in its original Arabic. * The [src/json/en/](src/json/en/) directory contains an English translation of The Qur'an. @@ -24,52 +21,20 @@ section. * The [src/json/pt/](src/json/pt/) directory contains a Portuguese translation of The Qur'an. -#### Chapters - -* [src/json/chapter-metadata.json](/src/json/chapter-metadata.json) - -The [chapter-metadata.json](/src/json/chapter-metadata.json) file was obtained from https://quran.com, -and modified slightly. - -The [chapter-metadata.json](/src/json/chapter-metadata.json) file contains information about each -chapter in The Qur'an. It is structured as an array of objects, with each object describing -a given chapter. The following example demonstrates how Al-Fatihah is described as an object. -The "codepoints" property is a sequence of unicode codepoints that can be mapped back -to Arabic - for example by using JavaScript's `String.fromCodePoint(...codepoints)`. - -```json - { - "id": "1", - "place_of_revelation": "makkah", - "transliterated_name": "Al-Fatihah", - "translated_name": "The Opener", - "verse_count": 7, - "slug": "al-fatihah", - "codepoints": [ - 1575, - 1604, - 1601, - 1575, - 1578, - 1581, - 1577 - ] - }, -``` +* The [src/json/chapter-metadata.json](src/json/chapter-metadata.json) file + contains information about each chapter in The Qur'an. #### Arabic -* [src/json/ar/](src/json/ar/) +* [src/json/ar/](src/json/ar/)
+ [Source: https://sacred-texts.com](https://sacred-texts.com) -The Arabic translation was obtained from the website https://sacred-texts.com. - -Each JSON file represents a chapter, or surah - in its original Arabic. -For example, [src/json/ar/1.json](src/json/ar/1.json) contains Al-Fatihah. - -The structure of the file can be described as an array whose first element is an -object that contains information aboout the chapter, and the rest of the array is composed -of two-element arrays - the first element being the verse number, and the second element -being the contents of the verse. For example: +Each JSON file represents a chapter, or surah. For example - +[src/json/ar/1.json](src/json/ar/1.json) contains Al-Fatihah. The structure of the JSON +files can be described as an array where the first element is an object that contains +information aboout the chapter, and the rest of the array is composed of two-element arrays - +the first element being the verse number, and the second element being the contents of +the verse. For example: ``` [ @@ -92,18 +57,16 @@ being the contents of the verse. For example: #### English -* [src/json/en/](src/json/en/) +* [src/json/en/](src/json/en/)
+ [Source: https://quran.com](https://quran.com) -The English translation is a copy of "The Clear Quran" - by Dr. Mustafa Khattab, -and it was obtained from the website https://quran.com. - -Each JSON file represents a chapter, or surah - as an English translation. -For example, [src/json/en/1.json](src/json/en/1.json) contains Al-Fatihah. - -The structure of the file can be described as an array whose first element is an -object that contains information aboout the chapter, and the rest of the array is composed -of two-element arrays - the first element being the verse number, and the second element -being the contents of the verse. For example: +The English translation is a copy of "The Clear Quran" - by Dr. Mustafa Khattab. +Each JSON file represents a chapter, or surah. For example - +[src/json/en/1.json](src/json/en/1.json) contains Al-Fatihah. The structure of the JSON +files can be described as an array where the first element is an object that contains +information aboout the chapter, and the rest of the array is composed of two-element +arrays - the first element being the verse number, and the second element being the +contents of the verse. For example: ``` [ @@ -141,17 +104,15 @@ being the contents of the verse. For example: #### Farsi -* [src/json/fa/](src/json/fa/) +* [src/json/fa/](src/json/fa/)
+ [Source: https://al-quran.cc](https://al-quran.cc) -The Farsi translation was obtained from the website https://al-quran.cc. - -Each JSON file represents a chapter, or surah - as a Farsi translation. -For example, [src/json/fa/1.json](src/json/fa/1.json) contains Al-Fatihah. - -The structure of the file can be described as an array whose first element is an -object that contains information aboout the chapter, and the rest of the array is composed -of two-element arrays - the first element being the verse number, and the second element -being the contents of the verse. For example: +Each JSON file represents a chapter, or surah. For example - +[src/json/fa/1.json](src/json/fa/1.json) contains Al-Fatihah. The structure of the JSON +files can be described as an array where the first element is an object that contains +information aboout the chapter, and the rest of the array is composed of two-element arrays - +the first element being the verse number, and the second element being the contents of +the verse. For example: ``` [ @@ -174,17 +135,15 @@ being the contents of the verse. For example: #### Portuguese -* [src/json/pt/](src/json/pt/) +* [src/json/pt/](src/json/pt/)
+ [Source: https://al-quran.cc](https://al-quran.cc) -The Portuguese translation was obtained from the website https://al-quran.cc. - -Each JSON file represents a chapter, or surah - as a Portuguese translation. -For example, [src/pt/1.json](src/json/pt/1.json) contains Al-Fatihah. - -The structure of the file can be described as an array whose first element is an -object that contains information aboout the chapter, and the rest of the array is composed -of two-element arrays - the first element being the verse number, and the second element -being the contents of the verse. For example: +Each JSON file represents a chapter, or surah. For example - +[src/pt/1.json](src/json/pt/1.json) contains Al-Fatihah. The structure of the JSON +files can be described as an array where the first element is an object that contains +information aboout the chapter, and the rest of the array is composed of two-element +arrays - the first element being the verse number, and the second element being the +contents of the verse. For example: ``` [ @@ -205,6 +164,39 @@ being the contents of the verse. For example: ] ``` +#### Chapter metadata + +* [src/json/chapter-metadata.json](/src/json/chapter-metadata.json)
+ [Source: https://quran.com](https://quran.com) + +The [src/json/chapter-metadata.json](/src/json/chapter-metadata.json) file contains +information about each chapter in The Qur'an. The JSON file is structured as an array +of objects, where each object describes a given chapter. + +The following example demonstrates how Al-Fatihah is described. The "codepoints" +property is a sequence of unicode codepoints that can be mapped back to Arabic +- for example by using JavaScript's `String.fromCodePoint(...codepoints)`. + +```json + { + "id": "1", + "place_of_revelation": "makkah", + "transliterated_name": "Al-Fatihah", + "translated_name": "The Opener", + "verse_count": 7, + "slug": "al-fatihah", + "codepoints": [ + 1575, + 1604, + 1601, + 1575, + 1578, + 1581, + 1577 + ] + }, +``` + ### `src/sql/` directory This section covers the SQL files.