cake
/
p7utils
Archived
1
0
Fork 0
Code

Corrected README.

This commit is contained in:
Thomas Touhey 2017-01-28 01:29:28 +01:00
parent 555bfb5813
commit 3524f752e1
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,12 +1,17 @@
# p7utils - Shell utilities for libp7
# p7utils - Shell utilities to interact with CASIO calculators and files
## Introduction
**p7utils** is a set of command-line utilities that allow you to interact with
your CASIO calculators/files:
your CASIO calculators/files. The name comes from the fact that it originally
was the merge of `p7`, `p7screen` and `p7os` (which had an almost identical
project structure), then the `g1mutils` (shell utilities for
[libg1m](https://github.com/cakeisalie5/libg1m/) merged with this project.
Available utilities are:
* `p7` will interact with the storage memories;
* `p7screen` will display the result of the screen streaming;
* `p7os` will allow you to interact with the calculator's OS (backup, flash);
* `mcsfile` will display the content of a **g1m** file.
* `mcsfile` will display the content of an MCS archive file.
## Prerequisites
### Making-only dependencies
@ -29,7 +34,7 @@ executables: only `p7screen` will require the SDL, and `mcsfile`
is the only one to require `libg1m`.
You should check `src/<name>/vars.mk` to see what the dependencies of
the particular executable you want (if you only want one) are (see
the particular executable you want are (if you don't want them all; see
the `libs` target).
## Building
@ -37,10 +42,12 @@ Just `./configure` then `make`. To install, use `make install`.
Make the manpages with `make all-doc` and install them with `make install-doc`.
Other useful targets :
- `all-<name>`: build only a given executable (and its doc);
- `install-<name>`: install only a given executable (and its doc, if
- `all-<name>[.exe]`: build only a given executable (and its doc);
- `install-<name>[.exe]`: install only a given executable (and its doc, if
`--noinstall-manpages` is not passed to the configure script);
- `uninstall-<name>`: uninstall only a given executable (and its doc);
- `clean`, `clean-<name>`, `clean-doc`: remove built files;
- `uninstall-<name>[.exe]`: uninstall only a given executable (and its doc);
- `clean`, `clean-<name>[.exe]`, `clean-doc`: remove built files;
- `mrproper`: remove all built files, and the configuration;
- `re`: remove all built files, and build all the default executables and docs.
Notice that the `.exe` suffix is facultative and is valid for all targets.