commit 176bd204b27d6973b583afc1c74be87c3003b72a
parent 8b723479ece5c56502d2fcb60022164c08ea1eb4
Author: Joris Vink <joris@coders.se>
Date: Mon, 1 Aug 2016 15:03:22 +0200
Update README
Diffstat:
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -28,6 +28,10 @@ License
-------
* Kore is licensed under the ISC license
+Documentation
+--------------
+[Read the documentation](https://jorisvink.gitbooks.io/kore-doc/content/)
+
Platforms supported
-------------------
* Linux
@@ -35,10 +39,9 @@ Platforms supported
* FreeBSD
* OSX
-See https://kore.io/doc/#requirements for more information.
-
Building Kore
-------------
+Fetch a release tarball or clone the repository.
Requirements
* openssl (latest)
@@ -71,7 +74,6 @@ those by setting a shell environment variable before running **_make_**.
Example applications
-----------------
-
You can find example applications under **_examples/_**.
The examples contain a README file with instructions on how
@@ -79,7 +81,6 @@ to build or use them.
Bugs, contributions and more
----------------------------
-
If you run into any bugs, have suggestions or patches please
contact me at joris@coders.se.