From 86084690b277e49239a4800df5714adabdfdf5cb Mon Sep 17 00:00:00 2001 From: actionless Date: Mon, 19 Nov 2018 22:01:37 +0100 Subject: [PATCH 1/2] doc(readme): add questions section; split issues and contributing; fix apidoc link (in ldoc) --- docs/01-readme.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/01-readme.md b/docs/01-readme.md index 219ddfa36..5c0e52c47 100644 --- a/docs/01-readme.md +++ b/docs/01-readme.md @@ -120,20 +120,30 @@ Then in gdb set any args and run it: (gdb) set arg --replace (gdb) run + +## Asking questions + +#### Stack Overflow +You can ask questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/awesome-wm). + +#### Reddit +We also have a [awesome subreddit](https://www.reddit.com/r/awesomewm/) where you can share your work and ask questions. ## Reporting issues Please report any issues you may find on [our bugtracker](https://github.com/awesomeWM/awesome/issues). + +## Contributing code + You can submit pull requests on the [github repository](https://github.com/awesomeWM/awesome). -Please read the [contributing guide](https://github.com/awesomeWM/awesome/blob/master/docs/02-contributing.md) -for any coding, documentation or patch guidelines. +Please read the [contributing guide](https://github.com/awesomeWM/awesome/blob/master/docs/02-contributing.md) for any coding, documentation or patch guidelines. ## Status [![Build Status](https://travis-ci.org/awesomeWM/awesome.svg?branch=master)](https://travis-ci.org/awesomeWM/awesome) ## Documentation -Online documentation is available at https://awesomewm.org/apidoc/. +Online documentation is available [here](https://awesomewm.org/apidoc/). ## License From 29b2b7138deba04b281fc25276bbf031ed726b3c Mon Sep 17 00:00:00 2001 From: actionless Date: Mon, 19 Nov 2018 22:09:46 +0100 Subject: [PATCH 2/2] doc(readme): add section about IRC --- docs/01-readme.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/01-readme.md b/docs/01-readme.md index 5c0e52c47..67183548e 100644 --- a/docs/01-readme.md +++ b/docs/01-readme.md @@ -123,6 +123,12 @@ Then in gdb set any args and run it: ## Asking questions +#### IRC + +You can join us in the `#awesome` channel on the [OFTC](http://www.oftc.net/) IRC network. + +[IRC Webchat](https://webchat.oftc.net/?channels=awesome) + #### Stack Overflow You can ask questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/awesome-wm).