From a65fb741d77ad2a94ba7e34ddbe9d18e4854de56 Mon Sep 17 00:00:00 2001 From: Paul Gear Date: Wed, 30 Oct 2013 17:48:36 +1000 Subject: [PATCH] Update readme; move doco to subdirectory --- README.md | 26 +++++++++++++++++++------- INSTALL.md => doc/INSTALL.md | 0 INSTALL_RHEL.md => doc/INSTALL_RHEL.md | 0 3 files changed, 19 insertions(+), 7 deletions(-) rename INSTALL.md => doc/INSTALL.md (100%) rename INSTALL_RHEL.md => doc/INSTALL_RHEL.md (100%) diff --git a/README.md b/README.md index eba305074..43535fb1e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ License Copyright (C) 2006-2012 Adam Armstrong - Copyright (C) 2013 LibreNMS Contributors This program is free software: you can redistribute it and/or modify @@ -41,11 +40,22 @@ The Debian Social Contract will be the basis of our priority system, and mutual respect the basis of our behaviour towards others. +For more about the culture we're trying to build, please read the Freenode +[guidelines for running an IRC channel][6] and [being a community +catalyst][7]. + + +Documentation +------------- + +For now documentation can be found in the [doc directory][5]. + Installation ------------ -See `INSTALL.md` for details. +See `doc/INSTALL.md` for details. + Contributing ------------ @@ -55,11 +65,13 @@ You can participate in the project by: suggestions. - Cloning the [repo][2] and filing bug reports and pull requests on github. - Talking to us on [Twitter][3] or [IRC][4]. -- Improving the [wiki][5]. +- Improving the [documentation][5]. [1]: https://groups.google.com/forum/#!forum/librenms-project "LibreNMS" -[2]: https://github.com/librenms/librenms -[3]: https://twitter.com/librenms -[4]: irc://irc.freenode.net/##librenms -[5]: https://github.com/librenms/librenms/wiki +[2]: https://github.com/librenms/librenms "Main LibreNMS GitHub repo" +[3]: https://twitter.com/librenms "@LibreNMS on Twitter" +[4]: irc://irc.freenode.net/##librenms "LibreNMS IRC channel" +[5]: https://github.com/librenms/librenms/tree/master/doc/ +[6]: http://freenode.net/channel_guidelines.shtml "Freenode channel guidelines" +[7]: http://freenode.net/catalysts.shtml "Freenode community catalysts" diff --git a/INSTALL.md b/doc/INSTALL.md similarity index 100% rename from INSTALL.md rename to doc/INSTALL.md diff --git a/INSTALL_RHEL.md b/doc/INSTALL_RHEL.md similarity index 100% rename from INSTALL_RHEL.md rename to doc/INSTALL_RHEL.md