]> Nishi Git Mirror - gwion.git/commitdiff
Add `gwion --cdoc` to documentation section (#231) [skip ci]
authorBen Rogmans <ben@amrai.nl>
Mon, 6 Sep 2021 21:54:28 +0000 (23:54 +0200)
committerGitHub <noreply@github.com>
Mon, 6 Sep 2021 21:54:28 +0000 (23:54 +0200)
README.md

index 188650593470f04ff007b1e2515aebb5fbdbbeb1..697f377197383a85959a2baa3e55546da4fa55c0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -122,7 +122,7 @@ When all those plugin `.so` files are in your `~/.gwplug` directory, you should
 
 ## Installation
 
-It's a good idea to install Gwion now that you have tried it out. Use the following command to install it
+It's a good idea to install Gwion now that you have tried it out. Use the following command to install it:
 ```
 sudo make install
 ```
@@ -143,11 +143,15 @@ To run it with Jack as the driver: `gwion hello_world.gw -dJack`. Hopefully you
 
 ## Documentation
 
-Do you want to know more? :smile: Look [here](https://Gwion.github.io/Gwion/)
-Both outdated and WIP :construction_worker: but a nice place to learn and [contribute](https://github.com/Gwion/gwion/issues)
+Run gwion with the --cdoc flag and it will show you everything that Gwion has to offer. Like so: 
 
+`gwion --cdoc --color=always | less -R` 
 
-## Reporting bugs / Contributing
+Online documentation is a work in progress :construction_worker: You can [view it here](https://Gwion.github.io/Gwion/). Please consider contributing ðŸ™‚ 
+
+If you need help with anything just [talk to us on Discord](https://discord.gg/KmHqbTKSmS). In general the audio programming community is very friendly and the people involved with Gwion are no exception.
+
+## Contributing / Reporting bugs
 
 :+1: Every helping hand is welcome!!! :+1: