0x1eef/al-quran_kaios
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update README

Browse source
This commit is contained in:
0x1eef 2024-10-17 23:39:11 -03:00
parent 5d2cea081b
commit ffc6e0a1a1
1 changed files with 4 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -12,7 +12,9 @@ The project is still in the early stages of development.
![img](/share/al-quran.reflectslight.io/screenshots/240x320_SurahIndex.png) ![img](/share/al-quran.reflectslight.io/screenshots/240x320_SurahIndex.png)
## Requirements ## Development
### Requirements
The following languages have to be installed to build The following languages have to be installed to build
the website from source: the website from source:
@ -20,7 +22,7 @@ the website from source:
* Ruby 3.2 (or later) * Ruby 3.2 (or later)
* NodeJS v18.15 (or later) * NodeJS v18.15 (or later)
## Development ### Examples
# Clone repository # Clone repository
git clone https://github.com/ReflectsLight/al-quran.reflectslight.io git clone https://github.com/ReflectsLight/al-quran.reflectslight.io
@ -43,22 +45,6 @@ the website from source:
## Configuration ## Configuration
* **server.base_url** <br>
If you plan to host the website on
your own domain you should update
[nanoc.yaml](nanoc.yaml.sample)
first. In certain places
links will reference
https://al-quran.reflectslight.io
instead of using a relative path.
For example
[/src/sitemap.xml.erb](/src/sitemap.xml.erb)
is one such place. Those links can be updated
to your own domain by changing the `server.base_url`
field in
[nanoc.yaml](nanoc.yaml.sample)
before running `bundle exec rake nanoc:build`.
* **audio.base_url** <br> * **audio.base_url** <br>
`audio.base_url` controls what web server serves `audio.base_url` controls what web server serves
audio content. audio content.