File: README.md

package info (click to toggle)
chatty 0.8.9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,448 kB
  • sloc: ansic: 57,146; sql: 5,122; xml: 158; cpp: 39; makefile: 22; sh: 11; lisp: 8; javascript: 6
file content (62 lines) | stat: -rw-r--r-- 1,754 bytes parent folder | download | duplicates (2)
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
libcmatrix
==========

A [Matrix][matrix] protocol library written in C using GObject.

<div>
  <a href="https://source.puri.sm/Librem5/libcmatrix/pipelines"><img
     src="https://source.puri.sm/Librem5/libcmatrix/badges/main/pipeline.svg" /></a>
  <a href="https://source.puri.sm/Librem5/libcmatrix/coverage"><img
     src="https://source.puri.sm/Librem5/libcmatrix/badges/main/coverage.svg" /></a>
</div>

---

You can use the library if you are writing a matrix client in C.

libcmatrix requires GObject and Gio, and the library assumes that a glib main
event loop is running (All GTK apps have one)

libcmatrix handles all E2EE transparently. Handled messages/events are stored
in a local database.

## Dependencies
   - glib >= 2.70
   - gio >= 2.70
   - libsoup-3
   - ligbcrypt
   - libolm3
   - libsqlite3 >= 3.34

Source Repository: [GitLab][gitlab]

Issues and Feature Requests: [GitLab][issues]

## Getting started

   See `examples` directory for examples on how to use the library.
   You typically use it as a [meson subproject](./doc/build-howto.md).

   Currently libcmatrix provides no API nor ABI guarantee until it's
   stable enough.

## Documentation

The API documentation can be browsed [here][]

## Known users

These applications use libcmatrix:

- [Chatty][chatty]: An instant messaging app
- [Eigenvalue][eigenvalue]: A client to test libcmatrix


<!-- Links referenced elsewhere -->
[matrix]: https://matrix.org
[coverage]: https://source.puri.sm/Librem5/libcmatrix/coverage
[gitlab]: https://source.puri.sm/Librem5/libcmatrix/
[issues]: https://source.puri.sm/Librem5/libcmatrix/issues
[chatty]: https://gitlab.gnome.org/World/Chatty
[eigenvalue]: https://github.com/agx/eigenvalue
[here]: https://agx.github.io/libcmatrix/