0x1eef/al-quran.reflectslight.io
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Update README

Browse source
This commit is contained in:
0x1eef 2024-05-19 23:35:43 -03:00
parent 96bf486ad2
commit a89b6bcbde
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,15 +1,22 @@
## About ## About
[al-quran.reflectslight.io](https://al-quran.reflectslight.io) is This repository contains the source code of
a static website for reading (and listening to) The Noble Quran. [al-quran.reflectslight.io](https://al-quran.reflectslight.io),
After the website is built, the build directory consists of HTML, a static website for reading (and listening to)
CSS, JavaScript and other static assets that can be hosted by The Noble Quran. After the website is built,
nginx, apache, etc. the build directory consists of HTML, CSS, JavaScript
and other static assets that can be hosted by nginx,
apache, etc.
Please note that the audio files are hosted by
https://al-quran.reflectslight.io, and due to
their overall size they are only files **not**
kept in this repository.
## Environment ## Environment
The following languages and tools have to be installed to build The following languages and tools have to be
the website from source: installed to build the website from source:
* Ruby 3.1 (or later) * Ruby 3.1 (or later)
* NodeJS v18.15 (or later) * NodeJS v18.15 (or later)
@ -32,7 +39,7 @@ the website from source:
## Thanks ## Thanks
Alhamdulillah. Alhamdulillah
* Thanks to the graphic artists: * Thanks to the graphic artists:
- [RefreshIcon](/src/js/components/Icon.tsx) - [RefreshIcon](/src/js/components/Icon.tsx)
@ -41,9 +48,9 @@ Alhamdulillah.
* Thanks to the translators: * Thanks to the translators:
- English (The Clear Quran) by Dr. Mustafa Khattab - English (The Clear Quran) by Dr. Mustafa Khattab
- Farsi by Hussein Taji Kal Dari - Farsi by Hussain Ansarian
## License ## License
The "source code" is released under the terms of the GPL. <br> The "source code" is released under the terms of the GPL <br>
See [./LICENSE](./LICENSE) for details. See [./LICENSE](./LICENSE) for details