Skip to content

Commit 5411c9c

Browse files
committed
Minor README edits
1 parent 755b510 commit 5411c9c

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -131,24 +131,24 @@ To create another test project named foobar, call `scripts/setup.sh -s -x
131131

132132
To answer: "How do I integrate FlatCC into my project":
133133

134-
You can, but you do not have to, build the runtime library, and you do not need CMake.
134+
You do not need CMake and you do not need a prebuilt runtime library, though you can.
135135

136-
You need:
136+
You need to:
137137

138-
- The files generated by flatcc, obviously.
139-
- `include/flatcc` in the include path (correct version), using `-I include` if at flatcc root.
140-
- Link with zero or more .c files from `src/runtime` in your project (correct version).
138+
- Generate files with the flatcc tool, and include them.
139+
- Add `include/flatcc` in the include path (correct version), using `-I include` if at flatcc root.
140+
- Link with zero or more from `src/runtime/*.c` (correct version).
141141
- Possibly disable certain warnings (notably disable GCC pedantic). The main CMake project does that for you.
142-
- For some esoteric platforms maybe define `-DPORTABLE_...=0/1` to work around limitations
143-
like stdalign support, see portable headers for detail.
142+
- Potentially work around platform limitations, often using `-DPORTABLE_...=0/1`, e.g. if `stdalign.h`
143+
should be, but isn't, available on your platform. See `include/flatcc/portable/*.h` for details.
144144

145-
You should be able to compile a test project with just a single line like
145+
You should be able to compile a test project with just a single line like:
146146

147147
```
148148
cc -I include src/runtime/build.c myprogram.c
149149
```
150150

151-
If you only read flatbuffers, and do not build, verify, parse or print JSON,
151+
If you only read flatbuffer files, and do not build, verify, parse JSON, or print JSON,
152152
you will not need any runtime `.c` files.
153153

154154
You can look at the `../monster/scritps/build.sh` file to see how a minimal

0 commit comments

Comments
 (0)