Go to file
Thomas Touhey e6e8cd423f Corrected picture utilities and header, added editorconfig 2017-06-12 01:54:57 +02:00
doc Initial commit. 2017-06-12 01:06:23 +02:00
include Corrected picture utilities and header, added editorconfig 2017-06-12 01:54:57 +02:00
src Corrected picture utilities and header, added editorconfig 2017-06-12 01:54:57 +02:00
tools Initial commit. 2017-06-12 01:06:23 +02:00
.editorconfig Corrected picture utilities and header, added editorconfig 2017-06-12 01:54:57 +02:00
.gitignore Initial commit. 2017-06-12 01:06:23 +02:00
CONTRIBUTING.md Initial commit. 2017-06-12 01:06:23 +02:00
LICENSE.md Initial commit. 2017-06-12 01:06:23 +02:00
Makefile Initial commit. 2017-06-12 01:06:23 +02:00
Makefile.msg Initial commit. 2017-06-12 01:06:23 +02:00
Makefile.vars Initial commit. 2017-06-12 01:06:23 +02:00
README.md Initial commit. 2017-06-12 01:06:23 +02:00
configure Initial commit. 2017-06-12 01:06:23 +02:00

README.md

libcasio - Utilities for manipulating CASIO's protocols and file formats

Introduction

This is the central library in the P7 project, a project to free software surrounding CASIO calculators. It aims at being able to manage CASIO's proprietary protocols and file formats. It is basically a merge of two libraries of the P7 project: the libp7, which managed protocols, and the libg1m, which managed file formats.

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.

Because of libusb, the library compiles in C99. Without it, it compiles using C89.

Build-only dependencies

Name Version
make >= 4.0
gcc >= 4.9
binutils >= 2.25
asciidoc >= 8.6.9
gzip >= 1.6
pkg-config any

Build and runtime dependencies

Name Version
libfontcharacter >= 1.0
libusb >= 1.0
zlib >= 1.2.8

Configuring

First of all, the configure script has a help message where all of the options are listed. The defaults should be appropriate for a native build, just ./configure if that's what you want to do, but you should read at least the next paragraph.

If you're installing on or packaging for a GNU/Linux distribution, you might want to install the udev rule to let the access to the direct calculator connexions to normal users. As calculators can be connected as serial devices, which are attributed to the uucp group (on Manjaro GNU/Linux), I chose to attribute the uucp group to calculators plugged directly as USB. If you agree with that, just add the --udev option to the configuration command line; otherwise, make your own, or make nothing, I don't really care.

Building for the MS-Windows platform is supported, just use a -mingw32 target.

Also, building a static library, for both PC and embedded systems, is supported : just use the --static option. If you want to build a static library so that a cross-compiler that uses Microsoft Windows static library formats, add the --windows option (notice that for a -mingw32 target and a dynamic library generation, this option is automatically added).

Building and installing

Once configuring is done (necessary step), just make.
To install, use make install.

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.

If you ought to package this library, use the DESTDIR Makefile variable, e.g. make install DESTDIR=./package-root. Do not use the --root configure options for this, as configure tools (libp7-config and the pkg-config configuration file) will add what's in the --root option value but not in the DESTDIR option.

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.