Skip to content

Commit

Permalink
Readme: Use codeblocks for commands and file names
Browse files Browse the repository at this point in the history
  • Loading branch information
EwoutH authored Oct 23, 2019
1 parent c43c976 commit 4b64a56
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
Expand All @@ -30,37 +30,37 @@ 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
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
Expand All @@ -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`

0 comments on commit 4b64a56

Please sign in to comment.