README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46


# LimoX

The Linux on mobile XMPP (LimoX) client. It should be fast, compliant and
usable on mobile linux devices like smartphones or tablets.

![LimoX icon](build/icon.pdf)

Also mind the `ROADMAP` file, the [project page][1] and my [packaging
repository][2] for Arch Linux with support for LimoX. A nice reference which
helps me a lot is [Beej's Guide to Network Programming][3] aswell as [Gigi's
SDL2 tutorial][5] and the [SDL2 documentation][4].


## Building and dependencies

Install these build dependencies:

- GNU coreutils
- GNU make
- gcc
- pandoc
- texlive-core
- inkscape

Install these runtime dependencies:

- sdl2

Just run these commands to build, test and run:

```
make all
./build/limox
```

Run `make clean` to clean the build folder. You can get a help page by running
`./build/limox -h`.


[1]: https://xengineering.eu/git/limox
[2]: https://xengineering.eu/git/pkgbuilds
[3]: https://www.beej.us/guide/bgnet/html/
[4]: https://wiki.libsdl.org/SDL2/FrontPage
[5]: https://gigi.nullneuron.net/gigilabs/writing/sdl2-tutorials/