Annotation of prex/doc/README, Revision 1.1.1.1
1.1 nbrk 1:
2: Prex Operating System
3:
4:
5: What is Prex?
6: -------------
7:
8: The Prex project is an open source initiative to provide a portable
9: real-time operating system for embedded systems. Prex is designed
10: specifically for small footprint platforms. It is written in C language
11: from scratch based on a traditional micro kernel architecture.
12: The Prex kernel provides only fundamental features for task, thread, memory,
13: ipc, exception, and synchronization. The other basic OS functions such
14: like process, file system, application loading, and networking are provided
15: by user mode servers on top of the Prex kernel. This design allows systems
16: to execute both of native real-time task and generic UNIX process
17: simultaneously, without degrading the real-time performance. Futhermore, it
18: helps the platform designer to construct OS by choosing appropriate server
19: tasks for their target requirements.
20:
21:
22: Licensing
23: ---------
24:
25: Prex is royalty-free software released under BSD License.
26:
27:
28: Current Port
29: ------------
30:
31: Available port (arch-platform):
32:
33: - i386-pc
34: - i386-nommu
35: - arm-gba
36:
37:
38: How to Build?
39: -------------
40:
41: Step 1: Prepare Toolchain
42:
43: The following packages are required for compiling Prex.
44: - GCC 2.95.3 or later
45: - GNU Binutils 2.15 or later
46: - GNU Make
47:
48: The toolchain should be built appropriately for your target
49: architecture to cross-compile Prex.
50:
51: Step 2: Prepare Sources
52:
53: Unpack the sources and move to the top level directory of the source tree.
54:
55: $ cd /usr/src
56: $ tar zxvf prex-X.X.X.tar.gz
57: $ cd prex-X.X.X
58:
59: Step 3: Configure
60:
61: Setup target architecture and platform.
62: The following sample shows for i386-pc target.
63:
64: $ ./configure --target=i386-pc
65:
66: If you cross compile Prex from a different architecture and/or OS,
67: you have to set --cross-compile option. Please check other options
68: with --help option for 'configure'.
69:
70: Step 4: Build
71:
72: Run make (and pray :)
73:
74: $ make
75:
76:
77: Note) If you want to run 'make' at the subdirectory, you have to set the
78: SRCDIR as follow.
79:
80: $ export SRCDIR=/usr/src/prex-X.X.X
81:
82:
83: Directory Structure
84: -------------------
85:
86: Prex source code is divided into the following directories:
87:
88: conf System configuration files
89:
90: mk Common Makefiles
91:
92: include Common include files
93:
94: sys Prex microkernel
95: arch Architecture/platform dependent code
96: include Kernel headers
97: lib Common kernel library
98: ipc Inter process communication support
99: kern Kernel main code
100: mem Memory management code
101: sync Synchronize related code
102:
103: boot Boot loader
104: arm Architecture/platform dependent drivers
105: i386 Architecture/platform dependent drivers
106: include Platform independent headers
107: lib Common loader library
108: common Common boot loader code
109:
110: dev Device driver module
111: arm Architecture/platform dependent drivers
112: i386 Architecture/platform dependent drivers
113: include Platform independent headers
114: lib Common driver library
115: core Driver core component
116: gen Generic device drivers
117: power Power management driver
118:
119: usr User mode programs
120: arch Architecture/platform dependent code
121: bin User command binaries
122: include Header files
123: lib User libraries
124: server System servers
125: bin System utilities
126: test Function test programs
127: sample Sample programs
128:
129:
130: Documentation
131: -------------
132:
133: Please open the following HTML file to view the documents.
134:
135: /doc/html/doc/index.html
136:
137:
138: Project Website
139: ---------------
140:
141: More information about Prex can be found at:
142:
143: http://prex.sourceforge.net
144:
145:
146: Author
147: ------
148:
149: Kohsuke Ohtani <kohtani@users.sourceforge.net>
150:
151: Have fun! ;)
CVSweb