mirror of
https://github.com/librenms/librenms.git
synced 2024-09-21 10:28:13 +00:00
Update readme; move doco to subdirectory
This commit is contained in:
parent
4351087f0e
commit
a65fb741d7
26
README.md
26
README.md
@ -3,7 +3,6 @@ License
|
||||
|
||||
Copyright (C) 2006-2012 Adam Armstrong <adama@memetic.org>
|
||||
|
||||
|
||||
Copyright (C) 2013 LibreNMS Contributors <librenms-project@googlegroups.com>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
@ -41,11 +40,22 @@ The Debian Social Contract <http://www.debian.org/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"
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user