aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2016-06-28 14:09:08 +0200
committerDaniel Stenberg <daniel@haxx.se>2016-06-28 14:09:51 +0200
commitc8b2010c5f225ea0c3922ca198dfe1ed9502d591 (patch)
tree5472c6fd384de91f6a0c07164abf95855d982a17 /docs/README.md
parentbf3222e053d03d044f70af59426db2f278201f2d (diff)
docs/README.md: to render nicer pages on github
... as previously the README.cmake would be picked and put at the bottom of the docs page there and it wasn't very representative!
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 000000000..eaf85ae2f
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,12 @@
+![curl logo](https://cdn.rawgit.com/curl/curl-www/master/logo/curl-logo.svg)
+
+# Documentation
+
+You'll find a mix of various documentation in this directory and
+subdirectories, using several different formats. Some of them are not ideally
+for reading directly in your browser.
+
+If you rather see the rendered version of the documentation, check out the
+curl web site's [documentation section](https://curl.haxx.se/docs/) for
+general curl stuff or the [libcurl section](https://curl.haxx.se/libcurl/) for
+libcurl related documentation.