Skip to content
Snippets Groups Projects
Commit 162a1404 authored by Amin Bandali's avatar Amin Bandali
Browse files

index: add some info from old wiki home page and drop it

Change-Id: I550550e49365adaed1f0ceaf50c652055417041f
parent df326861
Branches
No related tags found
No related merge requests found
<div>
![Jami Logo](https://jami.net/assets/images/logo-jami.svg)
</div># What is Jami?
Jami is free software for universal communication which respects freedoms and privacy of its users.
Its main goal is to provide a communication framework and end-user applications to make audio or video calls, send text messages and make generic data transfers. It makes this possible via multiple paradigms: a modern decentralized approach using a DHT to find peers or classical centralized SIP as a soft-phone. The domain of usage is not limited to physical users, it also includes integration with connected objects (IoT).
Available on all major platforms, this free software project is led by [Savoir-faire Linux](https://www.savoirfairelinux.com/en/) - a Canadian/Quebecois GNU/Linux consulting company - and is supported by the global community.
As a free software its sources are licensed under the [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.html).
### Contributions, help and suggestions are very welcome!
Feel free to open tickets on our [Gitlab](https://git.jami.net), help us with the translation, documentation, packaging, code, tests, etc.
You can contact us:
- via <https://git.jami.net>
- via IRC: **<span dir="">#</span>jami** on [Libera.Chat](https://web.libera.chat)
- via Matrix: **<span dir="">#</span>jami:matrix.org**, bridged with the above IRC channel
- by sending a mail to the Jami mailing list, [jami@gnu.org](https://lists.gnu.org/mailman/listinfo/jami).
---
## End user notes
[User manual](user-manual)
This wiki contains technical documentation and resources for anyone who wants to understand how Jami works or if you want to develop something with the platform. If you are a end-user, please refer to our [website](https://jami.net) or the {doc}`user/faq`.
Also, if you prefer to build your binaries from source, please refer to the READMEs in repo.
Also, you can see features by client via {doc}`this page <user/all-features-by-client>`.
---
## How to build
How to build from source for GNU/Linux:\
<https://git.jami.net/savoirfairelinux/jami-client-qt/-/blob/master/INSTALL.md>
## Technical documentation
The technical documentation is mainly available {doc}`here <developer/introduction>`.
But this is the main parts:
+ [OpenDHT](https://opendht.net), a DHT library to provide the basis of our distributed network
+ {gitlab-project}`Nameserver <jami-nameservice>`, (optional) is our registration system based upon an Ethereum Blockchain, but anyone can implement theirs using the following informations:
- Description of the [REST API for name query](technical/Name-Server-Protocol)
+ The daemon in charge of the accounts management, SIP features, crypto, video, etc
+ The clients for all platform to interact with the daemon.
---
## Resources for contributors
- Auto-generated (Doxygen) [Daemon code documentation](https://docs.jami.net/doxygen/daemon/)
- Auto-generated (Doxygen) [LRC API documentation](https://docs.jami.net/doxygen/lrc/)
- Testing (LCOV) [Daemon coverage](https://docs.jami.net/coverage)
### Development Processes and Contributing
- The [Release Process](technical/release-process)
- [Reporting Bugs and Enhancements](tutorials/Bug-report-guide)
- [Working with Gerrit](tutorials/Working-with-gerrit), our Git repositories manager and code-review tool for all submitted patches
\ No newline at end of file
......@@ -3,9 +3,9 @@ Working with Gerrit
## Account Setup
+ Gerrit server: https://review.jami.net
+ User documentation: https://review.jami.net/Documentation/intro-user.html
+ Jami projects on Gerrit: https://review.jami.net/#/admin/projects/
+ Gerrit server: <https://review.jami.net>
+ User documentation: <https://review.jami.net/Documentation/intro-user.html>
+ Jami projects on Gerrit: <https://review.jami.net/admin/repos/>
1. Sign-in with your google or github account or git.jami.net account
2. You'll also need to [upload an SSH key](https://review.jami.net/settings/#SSHKeys) to be able to commit changes for review.
......
......@@ -5,8 +5,22 @@ Home
:alt: Jami logo
This is the documentation for `Jami <https://jami.net>`_, free/libre
software for universal communication that respects the freedom and
privacy of its users.
software for :doc:`universal communication <user/introduction>` that
respects the freedom and privacy of its users. Jami is available
across operating systems and platforms including GNU/Linux, macOS,
Windows, Android/Replicant, and iOS.
Jami is an official GNU package and you can redistribute it and/or
modify it under the terms of the `GNU General Public License
<https://www.gnu.org/licenses/gpl.html>`_ as published by the Free
Software Foundation, either version 3 of the License, or (at your
option) any later version. The Jami team :doc:`uses Gerrit for
development <developer/working-with-gerrit>` and code reviews, and
issues and feature requests are :doc:`tracked on the Jami GitLab
<user/bug-report-guide>`. The development of Jami is led by
`Savoir-faire Linux <https://savoirfairelinux.com/en>`_ --- a Canadian
GNU/Linux consulting company based in Montréal --- and is supported by
a growing global community of users and contributors.
This documentation is community-driven and :ref:`anyone can contribute
<contribute:Contributing to this documentation>`!
......@@ -18,10 +32,40 @@ This documentation is community-driven and :ref:`anyone can contribute
or the `OpenDHT wiki
<https://github.com/savoirfairelinux/opendht/wiki>`_.
Documentation manuals
---------------------
Here are the documentation manuals of Jami and details on how to
contribute to Jami:
.. toctree::
:maxdepth: 2
:maxdepth: 1
user/index
build/index
developer/index
contribute
Community and support
---------------------
You can reach the Jami developers and community of users at the
following public places:
- Jami's forum: https://forum.jami.net
- Jami's GNU mailing list: `jami@gnu.org
<https://lists.gnu.org/mailman/listinfo/jami>`_
- Jami's IRC channel on the Libera.Chat network:
`#jami <https://web.libera.chat/#jami>`_
- Jami's Matrix room: `#jami:matrix.org
<https://matrix.to/#/#jami:matrix.org>`_
(bridged with the above IRC channel)
- Jami's social media:
`@jami_social <https://nitter.net/jami_social>`_ (Twitter)
and `@Jami@mstdn.io <https://mstdn.io/@Jami>`_ (Fediverse)
- Jami's subreddit: `/r/jami <https://old.reddit.com/r/jami>`_
You can also contact the Jami team at Savoir-faire Linux directly via
email, at contact@jami.net. Additionally, Savoir-faire Linux offers
commercial support for Jami via https://jami.biz.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment