[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnurl] 204/411: examples/README: convert to markdown
From: |
gnunet |
Subject: |
[gnurl] 204/411: examples/README: convert to markdown |
Date: |
Wed, 13 Jan 2021 01:20:19 +0100 |
This is an automated email from the git hooks/post-receive script.
nikita pushed a commit to branch master
in repository gnurl.
commit 7b9e3c4b4c90faa65cf226c8355be27a52cd01b8
Author: Daniel Stenberg <daniel@haxx.se>
AuthorDate: Wed Sep 30 14:56:08 2020 +0200
examples/README: convert to markdown
Closes #6028
---
docs/examples/Makefile.am | 2 +-
docs/examples/{README => README.md} | 22 +++++++++-------------
2 files changed, 10 insertions(+), 14 deletions(-)
diff --git a/docs/examples/Makefile.am b/docs/examples/Makefile.am
index 44372a19c..b8fd1ffda 100644
--- a/docs/examples/Makefile.am
+++ b/docs/examples/Makefile.am
@@ -22,7 +22,7 @@
AUTOMAKE_OPTIONS = foreign nostdinc
-EXTRA_DIST = README Makefile.example Makefile.inc Makefile.m32 \
+EXTRA_DIST = README.md Makefile.example Makefile.inc Makefile.m32 \
Makefile.netware makefile.dj $(COMPLICATED_EXAMPLES)
# Specify our include paths here, and do it relative to $(top_srcdir) and
diff --git a/docs/examples/README b/docs/examples/README.md
similarity index 57%
rename from docs/examples/README
rename to docs/examples/README.md
index 6336c3733..f2ba0619e 100644
--- a/docs/examples/README
+++ b/docs/examples/README.md
@@ -1,8 +1,4 @@
- _ _ ____ _
- ___| | | | _ \| |
- / __| | | | |_) | |
- | (__| |_| | _ <| |___
- \___|\___/|_| \_\_____|
+# libcurl examples
This directory is for libcurl programming examples. They are meant to show
some simple steps on how you can build your own application to take full
@@ -11,26 +7,26 @@ advantage of libcurl.
If you end up with other small but still useful example sources, please mail
them for submission in future packages and on the website.
-BUILDING
+## Building
The Makefile.example is an example makefile that could be used to build these
examples. Just edit the file according to your system and requirements first.
Most examples should build fine using a command line like this:
- $ `curl-config --cc --cflags --libs` -o example example.c
+ `curl-config --cc --cflags --libs` -o example example.c
Some compilers don't like having the arguments in this order but instead
want you do reorganize them like:
- $ `curl-config --cc` -o example example.c `curl-config --cflags --libs`
+ `curl-config --cc` -o example example.c `curl-config --cflags --libs`
-*PLEASE* do not use the curl.haxx.se site as a test target for your libcurl
-applications/experiments. Even if some of the examples use that site as a URL
-at some places, it doesn't mean that the URLs work or that we expect you to
-actually torture our website with your tests! Thanks.
+**Please** do not use the `curl.haxx.se` site as a test target for your
+libcurl applications/experiments. Even if some of the examples use that site
+as a URL at some places, it doesn't mean that the URLs work or that we expect
+you to actually torture our website with your tests! Thanks.
-EXAMPLES
+## Examples
Each example source code file is designed to be and work stand-alone and
rather self-explanatory. The examples may at times lack the level of error
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [gnurl] 213/411: tool_setopt: escape binary data to hex, not octal, (continued)
- [gnurl] 213/411: tool_setopt: escape binary data to hex, not octal, gnunet, 2021/01/12
- [gnurl] 260/411: curl_url_set.3: fix typo in the RETURN VALUE section, gnunet, 2021/01/12
- [gnurl] 234/411: tests/server/util.c: fix support for Windows Unicode builds, gnunet, 2021/01/12
- [gnurl] 235/411: CI/tests: fix invocation of tests for CMake builds, gnunet, 2021/01/12
- [gnurl] 227/411: checksrc: detect // comments on column 0, gnunet, 2021/01/12
- [gnurl] 199/411: sectransp: make it build with --disable-proxy, gnunet, 2021/01/12
- [gnurl] 246/411: runtests: return error if no tests ran, gnunet, 2021/01/12
- [gnurl] 228/411: runtests.pl: use $LIBDIR variable instead of hardcoded path, gnunet, 2021/01/12
- [gnurl] 211/411: strerror: fix null deref on winapi out-of-memory, gnunet, 2021/01/12
- [gnurl] 237/411: mailmap: fixups of some contributors, gnunet, 2021/01/12
- [gnurl] 204/411: examples/README: convert to markdown,
gnunet <=
- [gnurl] 252/411: http3: fix two build errors, silence warnings, gnunet, 2021/01/12
- [gnurl] 191/411: schannel: return CURLE_PEER_FAILED_VERIFICATION for untrusted root, gnunet, 2021/01/12
- [gnurl] 264/411: CMake: call the feature unixsockets without dash, gnunet, 2021/01/12
- [gnurl] 207/411: tests/unit/README: convert to markdown, gnunet, 2021/01/12
- [gnurl] 261/411: RELEASE-NOTES: synced, gnunet, 2021/01/12
- [gnurl] 215/411: test1465: verify --libcurl with binary POST data, gnunet, 2021/01/12
- [gnurl] 192/411: ROADMAP: updates and cleanups, gnunet, 2021/01/12
- [gnurl] 242/411: RELEASE-NOTES: synced, gnunet, 2021/01/12
- [gnurl] 262/411: runtests: revert the mistaken edit of $CURL, gnunet, 2021/01/12
- [gnurl] 195/411: libssh2: handle the SSH protocols done over HTTPS proxy, gnunet, 2021/01/12