changeset 5:9dd0e08d2ec3

- Add contribute - Fill downloads - Fill documentation
author David Demelier <markand@malikania.fr>
date Tue, 09 Feb 2016 13:31:41 +0100
parents efcb95802d3a
children 1b6953be3a7b
files CMakeLists.txt contribute.md documentation.md download.md
diffstat 4 files changed, 64 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/CMakeLists.txt	Mon Feb 08 16:21:38 2016 +0100
+++ b/CMakeLists.txt	Tue Feb 09 13:31:41 2016 +0100
@@ -36,7 +36,7 @@
 file(COPY ${CMAKE_SOURCE_DIR}/js DESTINATION ${OUTPUT})
 
 # Define the files to generate.
-set(FILES about index documentation download support)
+set(FILES about contribute documentation documentation download support)
 
 # Arguments for specific files.
 set(index_VARS home:yes)
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/contribute.md	Tue Feb 09 13:31:41 2016 +0100
@@ -0,0 +1,21 @@
+---
+title: "IRC Client Daemon - Download"
+---
+
+<div class="page-header">
+ <h1>Contribute</h1>
+</div>
+
+Irccd is a free software, you may edit it and update everything you want. You may also send patch to fix bugs, typos
+and so on.
+
+## Correct language
+
+As you might have already noticed, english is not my native tongue. There are probably lot of mistakes in the source
+code or in these pages. Please free to report them by mail at **markand (at) malikania (dot) fr**.
+
+## Fix bugs / add features
+
+If you are programmer, you can correct some bugs on our [bug tracker][bt]. You can also add new features.
+
+[bt]: https://redmine.malikania.fr/projects/irccd
--- a/documentation.md	Mon Feb 08 16:21:38 2016 +0100
+++ b/documentation.md	Tue Feb 09 13:31:41 2016 +0100
@@ -5,3 +5,18 @@
 <div class="page-header">
  <h1>Documentation</h1>
 </div>
+
+## General documentation
+
+  - [User guide](guide.html)
+  - [JavaScript API](api/index.html)
+
+## Plugin documentation
+
+  - [ask](plugin/ask.html)
+  - [auth](plugin/auth.html)
+  - [hangman](plugin/hangman.html)
+  - [history](plugin/history.html)
+  - [logger](plugin/logger.html)
+  - [plugin](plugin/plugin.html)
+  - [roulette](plugin/roulette.html)
--- a/download.md	Mon Feb 08 16:21:38 2016 +0100
+++ b/download.md	Tue Feb 09 13:31:41 2016 +0100
@@ -6,3 +6,30 @@
  <h1>Download</h1>
 </div>
 
+## Prebuilt binaries
+
+Prebuilt binaries are only provided for Windows.
+
+<div class="btn-group" role="group" aria-label="...">
+ <p><a class="btn btn-default btn-group-lg" href="#" role="button">irccd-2.0.0-Windows-amd64.exe</a></p>
+ <p><a class="btn btn-default btn-group-lg" href="#" role="button">irccd-2.0.0-Windows-x86.exe</a></p>
+</div>
+
+## From source
+
+You can compile irccd from sources.
+
+<div class="btn-group" role="group" aria-label="...">
+ <p><a class="btn btn-default btn-group-lg" href="#" role="button">irccd-2.0.0.tar.xz</a></p>
+ <p><a class="btn btn-default btn-group-lg" href="#" role="button">irccd-2.0.0.zip</a></p>
+</div>
+
+## Development version
+
+You can also install it from [Mercurial][].
+
+````
+$ hg clone http://hg.malikania.fr/irccd
+````
+
+[Mercurial]: http://mercurial-scm.org