mirrors/wormhole
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

More writing

Browse source 
FossilOrigin-Name: 978c2b66a7c1422a8d77bbb1dd524bb1669d2a37f94aa81b5567754b0a2a11b2
This commit is contained in:
nekobit 2022-12-28 20:56:12 +00:00
parent 5e6cf08d14
commit 365329bbbb
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -7,19 +7,20 @@
Wormhole is a lightweight federated social media server which allows
for efficient communication between ActivityPub servers.
- **Fast** -- Wormhole is written in modern C++ and utilizes efficient
- **Fast** -- Wormhole is written in semi-modern C++ and utilizes efficient
libraries such as RapidJSON for parsing.
- **Lightweight** -- Incredibly tiny resource usage, with the choice of
SQLite or PostgreSQL for the backend.
- **Lightweight** -- Incredibly tiny resource usage is possible, with the
choice of SQLite or PostgreSQL for the backend.
- **Portable** -- Completely distributable, no need to compile from
source to change a configuration option or run migrations. Wormhole
is a self-contained powerful executable.
- **Modular and Extensible** -- Designed for easy development and drop-in
implementations for new protocols, including run-time plugins and
compile-time modules.
- **Easy to setup** -- Wormhole is very simple to setup; run the
executable once to generate a config if not already done.
- Powerful when needed -- Nearly every component can be customized,
- **Easy to setup** -- Wormhole is very simple to setup; run the executable
once to generate a config if not already done. If you don't understand the
above, you may even be fine :-)
- **Powerful when needed** -- Nearly every component can be customized,
from caching, federation thresholds, or even low-end database
options.
- **Compatible** -- Bring your own Pleroma/mastodon database, switch
@ -46,12 +47,12 @@ the `index.html` file is simply placed for convience.
Wormhole uses CMake as the primary build system. Create a build
directory, then run CMake to generate the build files, followed by
your build mechanism (GNU Make).
your build mechanism (i.e. GNU Make).
## Build Dependencies names (by package manager)
<!-- - Debian/Ubuntu (apt): `todo` -->
- Void Linux (xbps): `rapidjson openssl-devel`
- Void Linux (xbps): `rapidjson openssl-devel libmicrohttpd-devel libcurl-devel`
<!-- - Arch (pacman): `todo` -->
<!-- - macOS (brew): `todo` -->
<!-- - Fedora/RHEL (dnf): `todo` -->