]> granicus.if.org Git - curl/commitdiff
docs/README.md: to render nicer pages on github
authorDaniel Stenberg <daniel@haxx.se>
Tue, 28 Jun 2016 12:09:08 +0000 (14:09 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Tue, 28 Jun 2016 12:09:51 +0000 (14:09 +0200)
... as previously the README.cmake would be picked and put at the bottom
of the docs page there and it wasn't very representative!

docs/README.md [new file with mode: 0644]

diff --git a/docs/README.md b/docs/README.md
new file mode 100644 (file)
index 0000000..eaf85ae
--- /dev/null
@@ -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.