Added a README.
This commit is contained in:
parent
665d1b2d12
commit
698c550f85
|
@ -0,0 +1,40 @@
|
|||
# libfontcharacter - Library for manipulating CASIO's character encoding
|
||||
## Introduction
|
||||
This library is there to manipulate CASIO's character encoding, which is
|
||||
used on its calculators. It's called `FONTCHARACTER` as it's the name of
|
||||
the "type" (actually, it's a define) of the characters in its SDK.
|
||||
|
||||
## Prerequisites
|
||||
Side note: the library might work with older versions of these dependencies,
|
||||
I took these as a reference because these are the ones I work with.
|
||||
|
||||
### Making-only dependencies
|
||||
| Name | Version |
|
||||
| -------------------------------------------------- | -------- |
|
||||
| [make](https://www.gnu.org/software/make/) | >= 4.0 |
|
||||
| [gcc](https://gcc.gnu.org/) | >= 4.9 |
|
||||
| [binutils](https://www.gnu.org/software/binutils/) | >= 2.25 |
|
||||
| [asciidoc](http://asciidoc.org/) | >= 8.6.9 |
|
||||
| [gzip](https://www.gnu.org/software/gzip/) | >= 1.6 |
|
||||
| [python3](https://www.python.org/) | >= 3.5 |
|
||||
|
||||
## Building
|
||||
Just `./configure` then `make`.
|
||||
To install, use `make install`.
|
||||
|
||||
If you're using a custom target, by default, the prefix will be
|
||||
`/usr/<target>`; to change this, use file options using the
|
||||
configure script options (see `./configure --help`).
|
||||
To build a DLL for MS-Windows, use a XXX-wXX-mingwXX target.
|
||||
|
||||
To build and install only the lib, use `all-lib` then `install-lib`.
|
||||
To build and install only the docs, use `all-doc` and `install-doc`.
|
||||
|
||||
Other useful targets:
|
||||
|
||||
- `uninstall`, `uninstall-lib`, `uninstall-bin`, `uninstall-doc`:
|
||||
will try to uninstall using the current configuration (experimental);
|
||||
- `mostlyclean`, `clean`, `clean-doc`, `mostlyclean-lib`, `clean-lib`:
|
||||
remove built files at different levels;
|
||||
- `re`, `re-lib`, `re-doc`: regenerate built files at different levels
|
||||
(clean and build) -- useful when configuration is changed.
|
Reference in New Issue