Skip to content

Commit

Permalink
Merge pull request #229 from bertronika/readme-fixes
Browse files Browse the repository at this point in the history
Improve README.rst
  • Loading branch information
AltraMayor authored Oct 30, 2024
2 parents 8cbe984 + e9311a5 commit d9b0a6c
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ F3 stands for Fight Flash Fraud, or Fight Fake Flash.

.. _examples:

.. highlight:: bash

Examples
========

Expand Down Expand Up @@ -347,31 +345,33 @@ authors. This will improve their code as it has improved mine.
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``.

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
- ``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::
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.

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/`
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 in the same folder.
Expand Down

0 comments on commit d9b0a6c

Please sign in to comment.