quran-go

Read Qur'an right in the terminal.
git clone http://git.hanabi.in/repos/quran-go.git
Log | Files | Refs | README | LICENSE

README (2788B)

      1   __ _ _   _ _ __ __ _ _ __  
      2  / _` | | | | '__/ _` | '_ \ 
      3 | (_| | |_| | | | (_| | | | |
      4  \__, |\__,_|_|  \__,_|_| |_|
      5     |_|                      
      6 =============================
      7 
      8 
      9 quran fetches various quran translations right in the terminal. 
     10 This is a successor of now dysfunct quran.py, but is not bug-compatible.
     11 
     12 Build and run
     13 =============
     14 Assuming you have the golang compiler, run the following command:
     15 
     16 $ git clone https://git.hanabi.in/reops/quran-go.git
     17 $ cd quran-go
     18 $ make # or `go build -o quran src/main.go`
     19 $ ./quran help
     20 
     21 I have moved the binary to /usr/local/bin so I can play directly -- depending on
     22 your $PATH, consider moving the binary there.
     23 Alternatively, run `make install`.
     24 
     25 Usage
     26 =====
     27 
     28 quran [-delay[=<millisecs>]] [-decorate] [-trans[=<translation-id>]] <command> [<args>] 
     29 
     30 Flags
     31 -----
     32   -decorate:
     33     Specify if the chapters and verses should be decorated xor not.  Defaults to false.
     34   -delay <delay-ms>:
     35     Specify in ms, the delay between fetching aayahs.  I advice using at least
     36     500.  Defaults to 1000.
     37   -trans <translation-id>
     38     Select which translation to use.  Defaults to 131.
     39 
     40 Sub-commands
     41 ------------
     42 + about: Shows description of the binary.
     43 + details: Shows details about where the verses are fetchef from.
     44 + version: Prints version of the software.
     45 + ls-translations: List all available translations.
     46 
     47 Arguments
     48 ---------
     49 Argument is of the type <chapter[:verse1[-verse2]]>
     50 
     51 + `quran 1' will print the first chapter.
     52 + `quran 1:2' will print the chapter 1, verse 2.
     53 + `quran 1:3-5' will print verses of chapter 1 from 3 to 5.
     54 
     55 Source code
     56 ===========
     57 The source code uses git for version control.
     58 
     59 Get the source code by running:
     60 $ git clone http://git.hanabi.in/repos/quran-go.git
     61 
     62 The source code has three branches important dev, prod and master.
     63 + dev: new features are added committed to dev.
     64 + prod: branch refers to the code ready to be used for production.
     65 + master -- git.hanabi.in makes use of stagit
     66   <https://codemadness.org/stagit.html>.  Stagit requires a master branch to
     67   generate web-front-end, and hence, the branch exists.
     68 
     69 Additionally, the source code also has few tags.
     70 + One tag is called quran.py -- in fond memory of the initial script, which
     71   holds special place in my memory.
     72 + Other tags being semantic versioning (semver) of the software release.
     73 
     74 I don't plan to overly complicate the software, please mind UNIX philosophy
     75 before requesting features.
     76 
     77 Please email patches to <me+git@hanabi.in>.
     78 
     79 Authors
     80 =======
     81 + acagastya (Implementation of the stuff -- which anyone can do.)
     82 
     83 `git blame` should suffice.
     84 
     85 License
     86 =======
     87 
     88 This source code is licened under the GNU AGPLv3 license.  Read the LICENSE file
     89 to see what you can do with it, or read
     90 <https://www.gnu.org/licenses/agpl-3.0.en.html>