From 7b9e3c4b4c90faa65cf226c8355be27a52cd01b8 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Wed, 30 Sep 2020 14:56:08 +0200 Subject: examples/README: convert to markdown Closes #6028 --- docs/examples/Makefile.am | 2 +- docs/examples/README | 38 -------------------------------------- docs/examples/README.md | 34 ++++++++++++++++++++++++++++++++++ 3 files changed, 35 insertions(+), 39 deletions(-) delete mode 100644 docs/examples/README create mode 100644 docs/examples/README.md 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 deleted file mode 100644 index 6336c3733..000000000 --- a/docs/examples/README +++ /dev/null @@ -1,38 +0,0 @@ - _ _ ____ _ - ___| | | | _ \| | - / __| | | | |_) | | - | (__| |_| | _ <| |___ - \___|\___/|_| \_\_____| - -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 -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 - -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 - -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` - -*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 - -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 -checks you need in a real world, but that is then only for the sake of -readability: to make the code smaller and easier to follow. diff --git a/docs/examples/README.md b/docs/examples/README.md new file mode 100644 index 000000000..f2ba0619e --- /dev/null +++ b/docs/examples/README.md @@ -0,0 +1,34 @@ +# 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 +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 + +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 + +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` + +**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 + +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 +checks you need in a real world, but that is then only for the sake of +readability: to make the code smaller and easier to follow. -- cgit v1.2.1