Skip to content

Commit

Permalink
Merge pull request #23 from bor/fix/README
Browse files Browse the repository at this point in the history
Adapt syntax of README.md for markdown
  • Loading branch information
AltraMayor committed Sep 14, 2015
2 parents fc4af9d + 310eac5 commit 015facf
Showing 1 changed file with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions README.md
Expand Up @@ -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.
Expand All @@ -37,37 +39,36 @@ 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

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.

0 comments on commit 015facf

Please sign in to comment.