moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-12-24 09:08:49 -05:00
Code Issues Releases Wiki Activity

examples/README: convert to markdown

Browse Source 
Closes #6028
This commit is contained in:
Daniel Stenberg 2020-09-30 14:56:08 +02:00
parent c8204ed6a2
commit 7b9e3c4b4c
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
2 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/examples/Makefile.am
View File

@ -22,7 +22,7 @@
AUTOMAKE_OPTIONS = foreign nostdinc 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) Makefile.netware makefile.dj $(COMPLICATED_EXAMPLES)
# Specify our include paths here, and do it relative to $(top_srcdir) and # Specify our include paths here, and do it relative to $(top_srcdir) and

22
docs/examples/README → docs/examples/README.md
View File

@ -1,8 +1,4 @@
_ _ ____ _ # libcurl examples
___| | | | _ \| |
/ __| | | | |_) | |
| (__| |_| | _ <| |___
\___|\___/|_| \_\_____|
This directory is for libcurl programming examples. They are meant to show 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 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 If you end up with other small but still useful example sources, please mail
them for submission in future packages and on the website. 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 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. examples. Just edit the file according to your system and requirements first.
Most examples should build fine using a command line like this: 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 Some compilers don't like having the arguments in this order but instead
want you do reorganize them like: 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 **Please** do not use the `curl.haxx.se` site as a test target for your
applications/experiments. Even if some of the examples use that site as a URL libcurl applications/experiments. Even if some of the examples use that site
at some places, it doesn't mean that the URLs work or that we expect you to as a URL at some places, it doesn't mean that the URLs work or that we expect
actually torture our website with your tests! Thanks. 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 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 rather self-explanatory. The examples may at times lack the level of error