[doc] update clone urls to afify.dev/azan
[azan.git] / README.md
blob044b6d47cfefeba06bff386d3f8b91b57872d7fc
1 azan
2 =========
3 **prayers time calculator, written in nasm.**
5 - standalone nasm
6 - unix portable syscalls
7 - tested on Linux, OpenBSD, FreeBSD and NetBSD
8 - OpenBSD pledge.
9 - binary size ≈ 7 kb
10 - instructions ≈ 250-400
11 - branches ≈ 6-20
13 Installation
14 ------------
15 **dependency**
16 - nasm (assembler)
17 - ld (linker)
19 **current**
20 ```sh
21 git clone git://git.afify.dev/azan
22 cd azan/
23 make
24 make install
25 ```
26 **latest release**
27 ```sh
28 wget $(curl -s https://git.afify.dev/azan/tags.xml | grep --color=never -m 1 -o "\[v.*\]" | tr -d '[]' | awk '{print "https://git.afify.dev/azan/releases/azan-"$1".tar.gz"}')
29 tar -xzf azan-*.tar.gz && cd azan-*/
30 make
31 make install
32 ```
33 Run
34 ---
35 ```sh
36 $ azan
37 ```
38 Options
39 -------
40 ```sh
41 $ azan [-AaNnUuv]
42 $ man azan
43 ```
44 | option | description                                  |
45 |:------:|:---------------------------------------------|
46 | `-A`   | print all prayers time, 12-hour clock format.|
47 | `-a`   | print all prayers time, 24-hour clock format.|
48 | `-N`   | print next prayer time, 12-hour clock format.|
49 | `-n`   | print next prayer time, 24-hour clock format.|
50 | `-U`   | print all prayers time, unix-time format.    |
51 | `-u`   | print next prayer time, unix-time format.    |
52 | `-v`   | print version.                               |
55 Configuration
56 -------------
57 The configuration of azan is done by creating a custom config.s
58 and (re)compiling the source code.