source: rtems-graphics-toolkit/README

Last change on this file was 4ac0e41, checked in by Chirayu Desai <cdesai@…>, on 01/03/14 at 07:06:35

README: Add instructions explaining git submodule steps

  • Property mode set to 100644
File size: 3.9 KB
Line 
1#
2# $Id$
3#
4
5This is the RTEMS Graphics Toolkit. It is a collection of free software
6packages that are suitable for use in building graphical interfaces for
7RTEMS-based embedded systems.
8
9You should have RTEMS installed and configured for your BSP.  The
10RTEMS configuration should meet the following requirements:
11
12+ TCP/IP enabled
13  - not required at run-time but has endian swapping routines
14+ POSIX enabled
15
16Additionally, your BSP should have a framebuffer and pointing device
17(e.g. mouse, touch screen, etc).  This is an area where RTEMS and
18this kit needs improvement on configuration but the basics are in place.
19Also, to work with current version of Microwindows/nano-X,
20the framebuffer driver must be initialized in packed pixel mode
21
22Populate the git submodules:
23    $ git submodule init
24    $ git submodule update
25
26This will fetch the microwin and nxlib repositories
27
28The ./do_it script has the following parameters:
29
30    do_it [options]
31      -A - build and install all libraries
32      -a - build all libraries
33      -j - build JPEG support (default=no)
34      -p - build PNG support (default=no)
35      -t - build TIFF support (default=no)
36      -1 - build Adobe Type 1 font support (default=no)
37      -T - build Truetype font support (default=no)
38      -n - build Microwindows/Nano-X support (default=no)
39      -x - build Microwindows/Nano-X NXLib support (default=no)
40      -f - build FLTK support (default=no)
41      -c - clean after building (default=no)
42      -b - build only, do not install libraries (default=no)
43      -s - use sudo for make install (default=no)
44      -v - verbose
45
46    NOTES:
47      + Use of each option toggles the setting.  For example, \"-v -v -A -1\"
48        results in verbose=no and all steps done except Type 1 fonts and build only.
49      + RTEMS_MAKEFILE_PATH must be set
50      + By default, nothing is built.
51
52Below is an invocation for the pc386 BSP which should build all of the
53supported libraries and install them for the pc386 BSP which is installed
54into your ${HOME}.  RTEMS was configured with --prefix set to:
55${HOME}/rtems-4.10-work/bsp-install/
56
57RTEMS_MAKEFILE_PATH=${HOME}/rtems-4.10-work/bsp-install/i386-rtems4.10/pc386/ \
58    ./do_it -A -v
59
60The CFLAGS and target information are automatically gathered from the
61install Makefile information.  This is used to properly configure
62and install the desired graphics support libraries.
63This command also builds Microwin/Nano-X and NXLib which must be fetched from
64external repository.
65
66To be able tu build tests for FLTK package, users must not clean microwindows,
67as it uses for initializations the object files from the aformentioned package.
68
69After installing this, you can proceed to building Microwin/Nano-X.
70It is expected that this will be integrated into a future revision of the
71Graphics Toolkit.  We hope to add other libraries like SVGAlib in the future. 
72This is definitely an area in which users can contribute.
73
74--joel
75
76Usage Notes:
77
78Adobe Type 1 Library
79====================
80+ This needs .t1librc and an override on the location of t1 fonts.
81  Then we need to put some T1 fonts in the rootfs filesystem.
82  This works now by setting the environment variable.  See rtems_init.c
83  in the microwin source.
84
85FLTK
86====
87* As of December 2013, fltk does not build.
88  TODO: Fix the build / re-port fltk
89  Note: Upstream has switched to cmake while this is still using the old
90  autoconf system
91
92Libraries used:
93===============
94
95libjpeg      - (v8d)    http://www.ijg.org/
96libtiff      - (v4.0.2) http://www.libtiff.org/
97libpng       - (1.5.12) http://www.libpng.org/pub/png/libpng.html
98libfreetype  - (2.4.10) http://freetype.sourceforge.net/index2.html
99libt1        - (5.1.2)  http://www.t1lib.org/
100svgalib      - (1.4.3)  http://svgalib.org/
101fltk         - (1.3.0)  http://www.fltk.org
102
103Microwindows/Nano-X
104Upstream:
105    git://microwindows.org/microwin
106    git clone git://microwindows.org/nxlib
107
108Forked for RTEMS at:
109    git://github.com/alex-sever-h/microwin.git
110    git://github.com/alex-sever-h/nxlib.git
111
Note: See TracBrowser for help on using the repository browser.