Skip to content

Commit 44059c9

Browse files
committed
Enhanced README.md.
1 parent 0eadca8 commit 44059c9

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

Diff for: README.md

+21-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
The goal of this project is to build C and C++ standard libraries for use with the
66
Raspberry Pi bare metal environment [Circle](https://github.com/rsta2/circle).
77

8-
[Newlib](https://sourceware.org/newlib/) is used as the standard C library.
8+
[Newlib](https://sourceware.org/newlib/) is used as the standard C library. The fork
9+
[circle-newlib](https://github.com/smuehlst/circle-newlib) contains the changes for
10+
building Newlib in combination with Circle.
911

1012
## Getting Started
1113

@@ -25,6 +27,23 @@ cd circle-stdlib
2527
./build.bash
2628
```
2729

30+
The `build.bash` script has the following options:
31+
32+
```
33+
$ ./build.bash -h
34+
usage: build.bash [ <option> ... ]
35+
Build Circle with newlib standard C library.
36+
37+
Options:
38+
-c, --clean clean build results and exit
39+
-d, --debug build with debug information, without optimizer
40+
-h, --help show usage message
41+
-r <number>, --raspberrypi <number>
42+
Circle Raspberry Pi model number (1, 2, 3, default: 1)
43+
-s <path>, --stddefpath <path>
44+
path where stddef.h header is located
45+
```
46+
2847
### Building a Sample Program
2948

3049
```
@@ -37,7 +56,7 @@ make
3756
As a first step Newlib is built without any system calls being implemented. This means that
3857
all features that do not depend on system calls should work (e.g. math functions,
3958
`setjmp`/`longjmp`, `bsearch`, `qsort`), but everything that depends on "system calls" like
40-
`open`, `read` etc. does not work and return errors (e.g. stdio functions).
59+
`open`, `read` etc. does not work and returns errors (e.g. stdio functions).
4160

4261
## License
4362

0 commit comments

Comments
 (0)