Commit bf105816 authored by Maxim Cournoyer's avatar Maxim Cournoyer Committed by Guillaume Roguez

Small cleanup of the ring-daemon introductory material

* CODING: Update wiki URLs and refresh content.
* ChangeLog: Fix typo.
* README: Likewise, and use HTTPS for URLs.
* doc/README: Rephrase.
* man/README.manpages: Fix typo.

Change-Id: I9d320ae2e5bdfacc84293001f08abb442da35fb5
Reviewed-by: Guillaume Roguez's avatarGuillaume Roguez <guillaume.roguez@savoirfairelinux.com>
parent e6c7666a
= Coding standards =
= Coding Standards =
Please follow our coding standards when developing
http://projects.savoirfairelinux.com/projects/ring-daemon/wiki/Daemon_Coding_Rules
Please follow our coding standards when developing:
https://tuleap.ring.cx/plugins/mediawiki/wiki/ring/index.php?title=Libring_-_Coding_Rules
= Gerrit workflow =
= Gerrit Workflow =
We are now using Gerrit as a code review tool.
Wiki documentation: http://projects.savoirfairelinux.com/projects/ring/wiki/WorkingWithGerrit
Gerrit is used as a code review tool. It is also the primary Git repository.
Wiki documentation: https://tuleap.ring.cx/plugins/mediawiki/wiki/ring/index.php?title=Working_with_Gerrit
== commit messages ==
== Commit Messages ==
Use Issue: followed by the ticket number
Indicate the number of the related Tuleap issue in your commit message.
== commit-msg hook ==
You may want to install the commit-msg hook that inserts a Change-Id on commit messages:
The Gerrit commit-msg hook must be installed before code reviews can be pushed to Gerrit.
This is because Gerrit relies on a unique Change-Id that can be tracked. The commit-msg hook
takes care of inserting a Change-Id in your commit messages for you.
It can be installed in your local git repository with the following command:
$ gitdir=$(git rev-parse --git-dir); scp -p -P 29420 username@gerrit-ring.savoirfairelinux.com:hooks/commit-msg ${gitdir}/hooks/
Other documentation source:
== Gerrit integration with Jenkins ==
* http://strongspace.com/rtyler/public/gerrit-jenkins-notes.pdf
* https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger
Thank you team!
Test
This file is not used for logging changes but to satisfies autotool requirements.
Please, read NEWS file for changes.
This file is only to satisfy autotool requirements.
Please refer to the NEWS file for changes.
......@@ -23,7 +23,7 @@ GNU Ring is a Voice-over-IP software phone. We want it to be:
- user friendly (fast, sleek, easy to learn interface)
- professional grade (transfers, holds, optimal audio quality)
- compatible with Asterisk (using SIP account)
- de-centralized call (P2P-DHT)
- decentralized call (P2P-DHT)
- customizable
As the SIP/audio daemon and the user interface are separate processes,
......@@ -46,7 +46,7 @@ Short description of content of source tree
- src/ is the core of DRing.
- bin/ contains applications main code.
- bin/dbus, the D-Bus xml interfaces, and c++ bindings
- bin/dbus, the D-Bus XML interfaces, and C++ bindings
- bin/restcpp, the C++ REST API implemented with Restbed
About Savoir-faire Linux
......@@ -54,7 +54,7 @@ About Savoir-faire Linux
Savoir-faire Linux is a consulting company based in Montreal, Quebec.
For more information, please check out our website:
http://www.savoirfairelinux.com/
https://www.savoirfairelinux.com/
How to compile on Linux
......@@ -130,7 +130,7 @@ to 'clang' and 'clang++' respectively when calling ./configure.
Currently it is not possible to use the DBus interface mechanism, and the
interaction between daemon and client will not work; for each platform where
dbus is not available the client should implement all the methods in the
D-Bus is not available the client should implement all the methods in the
*_stub.cpp files.
How to compile with the REST API
......
This directory holds all the documentation files, that are interfaced on the
ring.cx website, and in other documentation areas.
This directory holds all the documentation files. This documentation
is made available online on the ring.cx website, as well as in other
documentation areas.
......@@ -3,11 +3,10 @@ CREATING MANPAGES
Procedure:
- Creating the manual pages under POD format. A template is available in this directory.
- Convert the pdo file in a manpage file:
- Convert the pod file into a manpage file:
pod2man --section=1 --release=$(VERSION) --center "" myapp.pod > myapp.1
- You are done! You can read the manpage file with:
groff -man -Tascii myapp.1
Ref: https://wiki.ubuntu.com/PackagingGuide/Complete#Man%20Pages
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment