Page MenuHomePhorge
Files F112962

README.md
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

README.md
View Options

# Description
kazv is a convergent matrix client and instant messaging app.
# License
Copyright (C) 2020-2023 the Kazv Project <https://lily-is.land/kazv>
kazv is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
kazv is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with kazv. If not, see <https://www.gnu.org/licenses/>.
# Compiled executables
| Operating system | Architecture | Format | Download links |
|------------------|--------------|----------|----------------------------------------------------|
| GNU/Linux | amd64 | AppImage | [Debug][gl-amd64-ai-d] [Production][gl-amd64-ai-p] |
[gl-amd64-ai-d]: https://lily.kazv.moe/kazv/kazv/-/jobs/artifacts/servant/download?job=build:GNU/Linux-amd64-debug
[gl-amd64-ai-p]: https://lily.kazv.moe/kazv/kazv/-/jobs/artifacts/servant/download?job=build:GNU/Linux-amd64-prod
# Installation
## For Gentoo users
If you are using Gentoo, you can use [tusooa-overlay][tusooa-overlay]
to install kazv.
[tusooa-overlay]: https://gitlab.com/tusooa/tusooa-overlay
## Dependencies
- ECM
- Qt5: Core Gui Qml QuickControls2 Svg Concurrent Multimedia
- KF5: Kirigami2 KConfig
- nlohmann_json
- libkazv
- cmark
## Build process
Normal build:
```
mkdir build && cd build
cmake ..
make install
```
Updating external JavaScript libraries (advanced, usually not needed):
You need to first have Node.js available.
```
cd src/js/Intl.js
npm install
cd ..
npm install
./transform.bash
```
# Contributing
## Dev chat
We use Matrix to communicate. Join the matrix room at [#kazv:tusooa.xyz](https://matrix.to/#/#kazv:tusooa.xyz).
## Bugs
Report bugs to [our repository on Lily Islands](https://lily-is.land/kazv/kazv) (chances are it is the page you are currently viewing), or email to [project-bugs@kazv.moe](mailto:project-bugs@kazv.moe).
Report security vulnerabilities using a confidential GitLab issue on Lily Islands, or email to [project-security@kazv.moe](mailto:project-security@kazv.moe).
## Write code
To contribute code to the Kazv Project, open a merge request on Lily Islands, or email your patch to [project-patch@kazv.moe](mailto:project-patch@kazv.moe).
## Donate
You can now donate to the Kazv Project on Liberapay: <https://liberapay.com/theKazvProject/>.

File Metadata

Mime Type
text/plain
Expires
Sun, Nov 24, 3:33 AM (17 h, 33 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
38671
Default Alt Text
README.md (2 KB)

Event Timeline