aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-03-02 20:16:06 +0100
committerLoïc Hoguin <[email protected]>2013-03-02 20:16:06 +0100
commita795b34f4670b782de1ef0bd1ee0d507b572a2fa (patch)
tree46dc195aa5611492602991248f03a1fbd006746a /doc
parent489073265f4654d05b585dd825a18f6e2e36e62a (diff)
downloadcowboy-a795b34f4670b782de1ef0bd1ee0d507b572a2fa.tar.gz
cowboy-a795b34f4670b782de1ef0bd1ee0d507b572a2fa.tar.bz2
cowboy-a795b34f4670b782de1ef0bd1ee0d507b572a2fa.zip
Add a simple README in the doc folder for guidance
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..24e092f
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,10 @@
+Cowboy documentation
+====================
+
+Documentation for Cowboy is available online at the following addresses:
+
+ * [README](http://ninenines.eu/docs/en/cowboy/HEAD/README)
+ * [User Guide](http://ninenines.eu/docs/en/cowboy/HEAD/guide/introduction)
+
+This folder is used for generating the Reference Manual. You can generate
+it yourself by typing `make docs` in the top-level Cowboy directory.