From 57f6e1e1bc72ccb4397b5b89e451da9925daac7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Thu, 23 Jul 2015 08:48:11 +0200 Subject: [PATCH] Some more hints where to find documentation and support --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2a8992c0..57ebc9ab 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,35 @@ OctoPrint ========= -[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=foosel&url=https://github.com/foosel/OctoPrint&title=OctoPrint&language=&tags=github&category=software) - OctoPrint provides a responsive web interface for controlling a 3D printer (RepRap, Ultimaker, ...). It is Free Software and released under the [GNU Affero General Public License V3](http://www.gnu.org/licenses/agpl.html). Its website can be found at [octoprint.org](http://octoprint.org). +The documentation is located at [docs.octoprint.org](http://docs.octoprint.org). + +You are currently looking at the source code repository of OctoPrint. If you already installed it +(e.g. by using the Raspberry Pi targeted distribution [OctoPi](https://github.com/guysoft/OctoPi)) and only +want to find out how to use it, [the documentation](http://docs.octoprint.org/) and [the public wiki](https://github.com/foosel/OctoPrint/wiki) +might be of more interest for you. You might also want to subscribe to [the mailing list](https://groups.google.com/group/octoprint) +or the [G+ Community](https://plus.google.com/communities/102771308349328485741) where there are other active users who might be +able to help you with any questions you might have. + Contributing ------------ -Please see the project's [Contribution Guidelines](https://github.com/foosel/OctoPrint/blob/master/CONTRIBUTING.md). +Contributions of all kinds are welcome, not only in the form of code but also with regards to the +[official documentation](http://docs.octoprint.org/) or [the public wiki](https://github.com/foosel/OctoPrint/wiki), support +of other users in the [bug tracker](https://github.com/foosel/OctoPrint/issues), +[the Mailinglist](https://groups.google.com/group/octoprint) or +[the G+ Community](https://plus.google.com/communities/102771308349328485741). + +If you think something is bad as it is about OctoPrint or its documentation the way it is, please help +in any way to make it better instead of just complaining about it -- this is an Open Source Project +after all :) + +For information about how to go about contributions of any kind, please see the project's +[Contribution Guidelines](https://github.com/foosel/OctoPrint/blob/master/CONTRIBUTING.md). Installation ------------