mirrors/Parsee
1
0
Fork 0
mirror of https://forge.fsky.io/lda/Parsee.git synced 2026-03-13 13:45:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

[META] Make a barebones README

Browse source
This commit is contained in:
LDA 2024-06-15 14:42:05 +02:00
commit 0815834d7d
1 changed files with 27 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README Normal file
View file

@ -0,0 +1,27 @@
# Parsee - the jealous XMPP<=>Matrix bridge
Parsee is a Matrix<=>XMPP bridge written in C99, with Cytoplasm, similar to Bifrost,
but it is NOT a drop-in replacment.
## Why?
### Naming
The name 'Parsee' is actually a reference to [Parsee Mizuhashi](https://en.touhouwiki.net/wiki/Parsee_Mizuhashi), a
"*bridge* princess".
### Reasoning (personal to LDA)
I hate Bifrost. I also wanted to dip my toes in XMPP, XML, and bridges a bit. Also, as a sister project to KappaChat,
this means that I can integrate Parsee with KappaChat however I wish it to be, which allows me to mess around with a
codebase I'm already familiar with.
~~Also dependency bad.~~
## BUILDING
```sh
$ make # This generates a 'parsee' executable.
$
```
## RUNNING
TODO
## DOCS
TODO