Add README.md

FossilOrigin-Name: f9a9730cbd4da7fee996fea06718062c80b659d65703d66398d6771a03b4b946
This commit is contained in:
Jonathan Schleifer 2020-10-03 09:51:51 +00:00
parent fac5300d9f
commit 7757922b5e

40
README.md Normal file
View file

@ -0,0 +1,40 @@
# ObjMatrix
## What is ObjMatrix?
ObjMatrix is a [Matrix](https://matrix.org) client library for
[ObjFW](https://objfw.nil.im).
It is currently in early development stages.
## How to build it?
You need [ObjFW](https://objfw.nil.im),
[ObjOpenSSL](https://fossil.nil.im/objopenssl) and
[ObjSQLite3](https://fossil.nil.im/objsqlite3) installed in order to do this.
You can install them all like this:
$ for i in objfw objopenssl objsqlite3 objmatrix; do
fossil clone https://fossil.nil.im/$i $i.fossil &&
mkdir $i &&
cd $i &&
fossil open ../$i.fossil &&
./autogen.sh &&
./configure &&
make &&
sudo make install &&
cd .. || break
done
You might need to install your distribution's -dev packages for OpenSSL and
SQLite3 beforehand. E.g. on Ubuntu:
$ sudo apt install libssl-dev libsqlite3-dev
## Contributing
Just create an account on the [ObjMatrix
Fossil](https://fossil.nil.im/objmatrix) and post your patch on the
[forum](https://fossil.nil.im/objmatrix/forum). After a few patches, you will
be granted commit access.