From b32729fb8a5ff5cdbd6c94ad327a09aa19396389 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Tue, 8 Mar 2016 20:29:31 +0100 Subject: [PATCH] Convert README, INSTALL etc to markdown --- INSTALL => INSTALL.md | 55 ++++++++++++++++-------------------- README => README.md | 45 ++++++++++++++--------------- packaging/biboumi.spec.cmake | 2 +- 3 files changed, 48 insertions(+), 54 deletions(-) rename INSTALL => INSTALL.md (86%) rename README => README.md (75%) diff --git a/INSTALL b/INSTALL.md similarity index 86% rename from INSTALL rename to INSTALL.md index dc0548b..7709fe9 100644 --- a/INSTALL +++ b/INSTALL.md @@ -1,14 +1,12 @@ -============== - tl;dr: -============== +tl;dr +===== -$ cmake . && make && ./biboumi + cmake . && make && ./biboumi If that didn’t work, read on. -============== - Dependencies -============== +Dependencies +============ Build and runtime dependencies: @@ -60,14 +58,13 @@ Libraries: if you are packaging biboumi in a distribution with Systemd. -============== - Configure -============== +Configure +========= Configure the build system using cmake, there are many solutions to do that, the simplest is to just run -% cmake . + cmake . in the current directory. @@ -75,13 +72,13 @@ The default build type is "Debug", if you want to build a release version, set the CMAKE_BUILD_TYPE variable to "release", by running this command instead: -% cmake . -DCMAKE_BUILD_TYPE=release -DCMAKE_INSTALL_PREFIX=/usr + cmake . -DCMAKE_BUILD_TYPE=release -DCMAKE_INSTALL_PREFIX=/usr You can also configure many parameters of the build (like customize CFLAGS, the install path, choose the compiler, or enabling some options like the POLLER to use), using the ncurses interface of ccmake: -% ccmake . + ccmake . In ccmake, first use 'c' to configure the build system, edit the values you need and finaly use 'g' to generate the Makefiles to build the system and @@ -111,53 +108,49 @@ The list of available options: Example: -% cmake . -DCMAKE_BUILD_TYPE=release -DCMAKE_INSTALL_PREFIX \ + cmake . -DCMAKE_BUILD_TYPE=release -DCMAKE_INSTALL_PREFIX \ -DWITH_BOTAN=1 -DWITHOUT_SYSTEMD=1 This command will configure the project to build a release, with TLS enabled (using Botan) but without using Systemd (even if available on the system). -============== - Build -============== +Build +===== - Once you’ve configured everything using cmake, build the project -% make + make -============= - Install -============= +Install +======= - And then, optionaly, Install the software system-wide -# make install + make install -============= - Testing -============= +Testing +======= You can run the test suite with -% make check + make check This project uses the Catch unit test framework, it will be automatically fetched with cmake, by cloning the github repository. You can also check the overall code coverage of this test suite by running -% make coverage + make coverage This requires gcov and lcov to be installed. -============= - Run -============= +Run +=== Run the software using the `biboumi` binary. Read the documentation (the -man page biboumi(1) or the “biboumi.1.md” file) for more information on how +man page biboumi(1) or the `biboumi.1.md` file) for more information on how to use biboumi. diff --git a/README b/README.md similarity index 75% rename from README rename to README.md index 015ada7..b8b5124 100644 --- a/README +++ b/README.md @@ -1,10 +1,5 @@ - _ _ _ _ -| |__ (_) |__ ___ _ _ _ __ ___ (_) -| '_ \| | '_ \ / _ \| | | | '_ ` _ \| | -| |_) | | |_) | (_) | |_| | | | | | | | -|_.__/|_|_.__/ \___/ \__,_|_| |_| |_|_| - -Homepage: http://biboumi.louiz.org +Biboumi +======= Biboumi is an XMPP gateway that connects to IRC servers and translates between the two protocols. It can be used to access IRC channels using any @@ -24,21 +19,25 @@ work around this issue: it just enforces the rules of the IRC server by telling the user that he/she must choose an ASCII-only nickname. An important goal is to keep the software (and its code) light and simple. -================ - Install -================ -Refer to the INSTALL file. -================ - Authors -================ +Install +======= +Refer to the [INSTALL][] file. + +Usage +===== + +Read [the documentation](doc/biboumi.1.md). + +Authors +======= Florent Le Coz (louiz’) -================= - Contact/Support -================= -XMPP ChatRoom: biboumi@muc.poez.io -Report a bug: https://dev.louiz.org/projects/biboumi/issues/new + +Contact/Support +=============== +* XMPP ChatRoom: biboumi@muc.poez.io +* Report a bug: https://dev.louiz.org/projects/biboumi/issues/new To contribute, the preferred way is to commit your changes on some publicly-available git repository (your own, or github @@ -50,11 +49,13 @@ github or a merge request on gitlab. Optionally you can come discuss your changes on the XMPP chat room, beforehand. -================= - Licence -================= + +Licence +======= Biboumi is Free Software. (learn more: http://www.gnu.org/philosophy/free-sw.html) Biboumi is released under the zlib license. Please read the COPYING file for details. + +[INSTALL]: INSTALL diff --git a/packaging/biboumi.spec.cmake b/packaging/biboumi.spec.cmake index 633a168..08b5c6d 100644 --- a/packaging/biboumi.spec.cmake +++ b/packaging/biboumi.spec.cmake @@ -56,7 +56,7 @@ make check %{?_smp_mflags} %files %{_bindir}/%{name} %{_mandir}/man1/%{name}.1* -%doc README COPYING doc/biboumi.1.md +%doc README.md COPYING doc/biboumi.1.md %{_unitdir}/%{name}.service %config(noreplace) %{biboumi_confdir}/biboumi.cfg