README
1 _______ _____ _____ _ _
2|__ __|_ _| / ____| | | | |
3 | | | | | | __ _| |__ | | ___ ___
4 | | | | | | / _` | '_ \| |/ _ \/ __|
5 | | _| |_ | |___| (_| | |_) | | __/\__ \
6 |_| |_____(_)_____\__,_|_.__/|_|\___||___/
7
8This library is part of the TILP framework by Romain Liévin et al.
9
10See the AUTHORS file for more detailed authorship information.
11
12-------------------------------------------------------------------------------
13Requirements
14-------------------------------------------------------------------------------
15
16OS:
17 - any *nix with a reasonably modern C compiler (a current GCC or Clang will
18 definitely work)
19 See the CONFIG file for device permission issues and how to solve them.
20 or
21 - Microsoft Windows, MSVC or MSYS+MinGW required for compiling from source
22
23Libraries:
24 - GLib 2 (required)
25 - libusb 0.1 or libusb 1.0 on *nix, or libusb-win32 (optional, required to use
26 USB cables)
27
28Tools for building from source:
29 - autoreconf (required)
30 - make (required)
31 - tfdocgen (optional, required to build API docs)
32
33-------------------------------------------------------------------------------
34Compilation
35-------------------------------------------------------------------------------
36
37Untar the libticables2 archive, change directory to the libticables2 directory.
38
39Type "autoreconf -i -f" to generate the autotools files.
40
41Type "./configure" (add --prefix option to install to a non-default location).
42Add --enable-libusb10 if you want to build against the libusb 1.0 backend,
43which will become default in the future.
44
45Type "make" and then "make install". "make install" requires root privileges
46to install to the default, system-wide location.
47
48NOTE: some cable handlers can be disabled using #define NO_CABLE_XXX.
49
50NOTE: building libticables against the libusb 1.0 compatibility layer for
51libusb 0.1 does *not* work, because some features required by libticables are
52not supported by this compatibility layer. You need to build either against
53libusb 0.1 proper, or use the libusb 1.0 backend.
54
55NOTE: on *nix, see the CONFIG file for device permission issues and how to
56solve them.
57
58-------------------------------------------------------------------------------
59Availability
60-------------------------------------------------------------------------------
61
62 http://lpg.ticalc.org/prj_tilp
63
64-------------------------------------------------------------------------------
65Copyright
66-------------------------------------------------------------------------------
67
68Copyright (C) 1999-2011 the TiLP team <tilp-users@lists.sf.net>
69See AUTHORS for detailed authorship information.
70
71This library is free software; you can redistribute it and/or modify it under
72the terms of the GNU General Public License as published by the Free Software
73Foundation; either version 2 of the License, or (at your option) any later
74version.
75
76(A special exception applies when linking the library into TilEm, see the
77COPYING file for details.)
78
79This library is distributed in the hope that it will be useful, but WITHOUT ANY
80WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
81PARTICULAR PURPOSE. See the GNU General Public License for more details.
82
83You should have received a copy of the GNU General Public License along with
84this library (in the COPYING file); if not, see <http://www.gnu.org/licenses/>.
85
86-------------------------------------------------------------------------------
87
88Texas Instruments and TI are trademarks of Texas Instruments Incorporated.
89For more informations: <http://education.ti.com/educationportal/sites/US/nonProductSingle/global_trademarks.html>
90This document has been written independently of Texas Instruments.
91
92Please report any bugs, questions, etc. on the SourceForge infrastructure
93(http://sourceforge.net/tilp). Please indicate your platform, your calculator
94type and ROM version.
95
96The TiLP team <tilp-users@lists.sf.net>
97