From 94b6c31246e180462ebb105487bfc4fa28ac1f39 Mon Sep 17 00:00:00 2001 From: altaf-creator <64111012+altaf-creator@users.noreply.github.com> Date: Thu, 11 May 2023 21:33:19 +0700 Subject: Add README --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..4534072 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# OpenQuran + + +ِبِسْمِ اللَّهِ الرَّحْمَنِ الرَّحِيْم + +السَّلاَمُ عَلَيْكُمْ وَرَحْمَةُ اللهِ وَبَرَكَاتُهُ + +OpenQuran is an online & offline (for Windows) Al-Qur'an Reader website & app. + +## Features +--- + +- Al-Qur'an +- Sura List +- Translation + - English + - Indonesia + +## Installation +--- + +### Download from Releases (Windows) +1. Download the .zip file [here](https://github.com/altaf-creator/OpenQuran/releases/tag/v1.0.0) +2. Unzip the file +3. Open the `OpenQuran` shortcut on the unzipped root folder **OR** navigate to `\OpenQuran-win32-x64` then open `OpenQuran.exe` + +### Compile using Electron Forge +1. Clone the repository using `git clone https://github.com/altaf-creator/OpenQuran.git` +2. Navigate to OpenQuran +3. Install dependencies using `npm install` +4. To preview your electron app, run `npm start` +5. To build your electron app, run `npm run start` + +### Add to Homescreen (Browser) +1. Open OpenQuran's website [here](https://altaf-creator.github.io/OpenQuran/) +2. Click your browser's menu (usually ⋯) +3. Click "Add to Homescreen" or "Install App" + +## Screenshots +--- + +![screenshot 1](readme-assets/screenshots/1.png) +![screenshot 2](readme-assets/screenshots/2.png) +![screenshot 3](readme-assets/screenshots/3.png) +![screenshot 4](readme-assets/screenshots/4.png) + + +## Credits & Attribution +--- +- [The Tanzil Project](https://tanzil.net) +- [Made with Electron](https://www.electronjs.org/) \ No newline at end of file -- cgit v1.2.3