From 310eac5bae6dc59004dcbf1e2a1a22c83ed9ed13 Mon Sep 17 00:00:00 2001 From: Sergiy Borodych Date: Mon, 14 Sep 2015 12:40:07 +0300 Subject: [PATCH] adapt syntax for markdown to show it as more nicer at github --- README.md | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 59aed56..52ed3cc 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,10 @@ NOTES: ### Use example of f3write/f3read -./f3write /media/michel/5EBD-5C80/ -./f3read /media/michel/5EBD-5C80/ +``` +$ ./f3write /media/michel/5EBD-5C80/ +$ ./f3read /media/michel/5EBD-5C80/ +``` Please replace "/media/michel/5EBD-5C80/" with the appropriate path. USB devices are mounted in "/Volumes" on Macs. @@ -37,16 +39,15 @@ For more information see http://oss.digirati.com.br/f3/ ### Files -changelog - Change log for package maintainers. -f3read.1 - Man page for f3read and f3write. - In order to read this manual page, run 'man ./f3read.1'. - To install the page, run - 'install --owner=root --group=root --mode=644 f3read.1 /usr/share/man/man1'. -LICENSE - License (GPLv3). -Makefile - make(1) file. -README - This file. - -*.h and *.c - C code of F3. + changelog - Change log for package maintainers + f3read.1 - Man page for f3read and f3write + In order to read this manual page, run `man ./f3read.1` + To install the page, run + `install --owner=root --group=root --mode=644 f3read.1 /usr/share/man/man1` + LICENSE - License (GPLv3) + Makefile - make(1) file + README - This file + *.h and *.c - C code of F3 ## Bash scripts @@ -54,20 +55,20 @@ Although the simple scripts listed in this section are ready for use, they are really meant to help you to write your own scripts. So you can personalize F3 to your specific needs. -f3write.h2w - Script to create files exactly like H2testw. - Use example: 'f3write.h2w /media/michel/5EBD-5C80/' + f3write.h2w - Script to create files exactly like H2testw. + Use example: `f3write.h2w /media/michel/5EBD-5C80/` -log-f3wr - Script that runs f3write and f3read, and records - their output into a log file. - Use example: 'log-f3wr log-filename /media/michel/5EBD-5C80/' + log-f3wr - Script that runs f3write and f3read, and records + their output into a log file. + Use example: `log-f3wr log-filename /media/michel/5EBD-5C80/` Please notice that all scripts and use examples above assume that f3write, f3read, and the scripts are reachable from your environment PATH variable. If that is not the case, but all of them are in your current path, -prefix the use examples above with 'PATH=$PATH:./' as shown below +prefix the use examples above with `PATH=$PATH:./` as shown below for the script log-f3wr: -PATH=$PATH:./ log-f3wr log-filename /media/michel/5EBD-5C80/ +`PATH=$PATH:./ log-f3wr log-filename /media/michel/5EBD-5C80/` -The current path is represented by './' in the previous example. +The current path is represented by `./` in the previous example.