Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/lvandeve/lodepng.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLode Vandevenne <lvandeve@users.noreply.github.com>2019-11-09 14:53:54 +0300
committerGitHub <noreply@github.com>2019-11-09 14:53:54 +0300
commit46108887d2013c18ab221503f68e34df7caa6269 (patch)
tree3b03468f24c8123309a447da1290ffcaa04f8411
parentf8700e02c554001bc3a2a346f6d1f6457c2a502a (diff)
parent4b64a564207dbae6e92f5c231cc3a5f2e598f45e (diff)
Merge pull request #111 from EwoutH/patch-2
Readme: Use codeblocks for commands and file names
-rw-r--r--README.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md
index a56b5e9..b50f837 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ Home page: http://lodev.org/lodepng/
### Documentation
Detailed documentation is included in a large comment in the second half of the
-header file lodepng.h.
+header file `lodepng.h`.
Source code examples using LodePNG can be found in the examples directory.
@@ -18,8 +18,8 @@ An FAQ can be found on http://lodev.org/lodepng/
Only two files are needed to encode and decode PNGs:
-* lodepng.cpp (or renamed to lodepng.c)
-* lodepng.h
+* `lodepng.cpp` (or renamed to `lodepng.c`)
+* `lodepng.h`
All other files are just source code examples, tests, misc utilities, etc...,
which are normally not needed in projects using this.
@@ -30,20 +30,20 @@ makefile, IDE project file, or other build system. No library is necessary.
In addition to C++, LodePNG also supports ANSI C (C89), with all the same
functionality: C++ only adds extra convenience API.
-For C, rename lodepng.cpp to lodepng.c.
+For C, rename `lodepng.cpp` to `lodepng.c`.
Consider using git submodules to include LodePNG in your project.
### Compiling in C++
-If you have a hypothetical your_program.cpp that #includes and uses lodepng.h,
+If you have a hypothetical `your_program.cpp` that #includes and uses `lodepng.h`,
you can build as follows:
-g++ your_program.cpp lodepng.cpp -Wall -Wextra -pedantic -ansi -O3
+`g++ your_program.cpp lodepng.cpp -Wall -Wextra -pedantic -ansi -O3`
or:
-clang++ your_program.cpp lodepng.cpp -Wall -Wextra -pedantic -ansi -O3
+`clang++ your_program.cpp lodepng.cpp -Wall -Wextra -pedantic -ansi -O3`
This shows compiler flags it was designed for, but normally one would use the
compiler or build system of their project instead of those commands, and other
@@ -51,16 +51,16 @@ C++ compilers are supported.
### Compiling in C
-Rename lodepng.cpp to lodepng.c for this.
+Rename `lodepng.cpp` to `lodepng.c` for this.
If you have a hypothetical your_program.c that #includes and uses lodepng.h,
you can build as follows:
-gcc your_program.c lodepng.c -ansi -pedantic -Wall -Wextra -O3
+`gcc your_program.c lodepng.c -ansi -pedantic -Wall -Wextra -O3`
or
-clang your_program.c lodepng.c -ansi -pedantic -Wall -Wextra -O3
+`clang your_program.c lodepng.c -ansi -pedantic -Wall -Wextra -O3`
This shows compiler flags it was designed for, but normally one would use the
compiler or build system of their project instead of those commands, and other
@@ -72,4 +72,4 @@ There is a Makefile, but this is not intended for using LodePNG itself since the
way to use that one is to include its source files in your program. The Makefile
only builds development and testing utilities. It can be used as follows:
-make -j
+`make -j`