Browse Source

Add README

vanitasvitae 1 year ago
parent
commit
e27ae15798
No known key found for this signature in database
1 changed files with 20 additions and 0 deletions
  1. 20
    0
      README.md

+ 20
- 0
README.md View File

@@ -0,0 +1,20 @@
1
+# Home Made OMEMO Client
2
+
3
+This is a repository containing the source code to my
4
+[blog post](https://blogs.fsfe.org/vanitasvitae/2017/06/14/homemo/) about how to
5
+build a home-made OMEMO chat application in less than 200 lines of code.
6
+
7
+## Setup
8
+You can clone the repository using `git clone https://git.fsfe.org/vanitasvitae/HomeMadeOmemo.git`
9
+
10
+Next navigate to the root folder and compile using
11
+```
12
+cd HomeMadeOmemo/de.vanitasvitae.homemadeomemo
13
+./gradlew build
14
+```
15
+
16
+## Run
17
+You can run the application as follows:
18
+```
19
+java -jar build/libs/de.vanitasvitae.homemadeomemo.jar user@server.tld password
20
+```