From 3a83fe68c9ed360c1a6259ab70cb067d9f698be8 Mon Sep 17 00:00:00 2001 From: Latysheva Alexandra <35174583+alexelex@users.noreply.github.com> Date: Fri, 30 Oct 2020 19:05:37 +0600 Subject: [PATCH] rewrite readme and correct mistakes in it --- oss-internship-2020/libpng/README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/oss-internship-2020/libpng/README.md b/oss-internship-2020/libpng/README.md index dcf5749..c649592 100644 --- a/oss-internship-2020/libpng/README.md +++ b/oss-internship-2020/libpng/README.md @@ -17,20 +17,28 @@ make -j8 #### Example: You should add `-DLIBPNG_SAPI_ENABLE_EXAMPLES=ON` to use the example.\ -run PNG to PNG: `./examples/pngtopng /absolute/path/to/input/image.png /absolute/path/to/output/image.png`\ -run RGB to BGR: `./examples/rgbtobgr /absolute/path/to/input/image.png /absolute/path/to/output/image.png` +run PNG to PNG: +``` +./examples/pngtopng /absolute/path/to/input/image.png /absolute/path/to/output/image.png +``` +run RGB to BGR: +``` +./examples/rgbtobgr /absolute/path/to/input/image.png /absolute/path/to/output/image.png +``` -Input and output examples can be found in images directory. +Examples of input and output can be found in `images`. PNG to PNG: \ -input: `/abs/path/to/project/images/pngtest.png`\ -output:` /abs/path/to/project/images/pngtopng_pngtest.png` +input: `images/pngtest.png`\ +output:` images/pngtopng_pngtest.png` RGB to BGR: \ -input: `/abs/path/to/project/images/red_ball.png`\ -output:` /abs/path/to/project/images/rgbtobgr_red_ball.png` +input: `images/red_ball.png`\ +output: `images/rgbtobgr_red_ball.png` #### Tests: -You should add `-DLIBPNG_SAPI_ENABLE_TESTS=ON` to use tests.\ -run: `./tests/tests` +You should add `-DLIBPNG_SAPI_ENABLE_TESTS=ON` to use tests and run: +``` +./tests/tests +```