-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME
91 lines (61 loc) · 3.04 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
Skinware: The Skin Middle-ware
==============================
0. Overview
-----------
Skinware in its core provides a flexible data chunk transfer mechanism between
two tasks, as is suitable for a skin-related application. Generic services
can be provided and used by starting writers and readers. Skin-tailored drivers
and users internally use writers and readers, but provide facilities over them
useful for a skin application.
Table of contents:
1) Prerequisites
2) Build and Installation
3) License
1. Prerequisites
----------------
First and foremost, you need to have URT installed:
https://github.com/ShabbyX/URT
URT provides the real-time abstraction layer. If use use RTAI as the real-time
back-end, make sure to read README.RTAI.
If you are building from source, you would need `autoconf-archive` to properly
generate the `configure` script.
On a Debian-based distribution, the following would do:
$ apt install autoconf-archive
To compile Skinware, you need the following compilers:
- gcc: for compiling the skin library, the tools and the calibrator,
- g++: for compiling the C++ library, and various apps.
There are a few graphical libraries needed by the visualizer, but as of the
current version, they are my own simple libraries and I have included them
with Skinware. You will need the following additional libraries:
- SDL : Simple DirectMedia Library (for window handling) (v1.2)
- OpenGL: Graphical rendering (higher than v1.2)
- GLU : OpenGL utilities library
On a Debian-based distribution, the following would do:
$ apt install libgl1-mesa-dev libglu1-mesa-dev libsdl1.2-dev
To build the documentation files, you need DocThis!
- DocThis!: https://github.com/ShabbyX/DocThis
(Let us cleanse this world of the horror that is doxygen!)
To build the documentation in pdf, the following software is also needed:
- pdflatex: To compile LaTeX files
2. Build and Installation
-------------------------
See INSTALL
3. License
----------
Copyright (C) 2011-2015 Maclab, DIBRIS, Universita di Genova <[email protected]>
Authored by Shahbaz Youssefi <[email protected]>
Skinware along with its documentations and accompanying drivers, services
and software including but not limited to the calibrator and visualizer
are published under the GNU General Public License version 2.0 or later (GPL v2.0+).
Skinware is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
Skinware is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Skinware. If not, see <http://www.gnu.org/licenses/>.
Other included libraries and software (Ngin, Ngin3d, shImage, shFont)
have their own licenses and are not part of Skinware.