You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-7Lines changed: 21 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,23 +11,37 @@ ObjectBox is a superfast cross-platform object-oriented database.
11
11
ObjectBox Generator produces binding code for ObjectBox C, C++ and Go APIs (more languages to be supported in the future).
12
12
This greatly simplifies using ObjectBox in your favourite language.
13
13
14
-
## Prerequisites/Installation
14
+
## Download
15
15
16
16
Install the objectbox-generator by downloading the latest binary for your OS from [releases](https://github.com/objectbox/objectbox-generator/releases/latest).
17
17
If you want, add it to `$PATH` for convenience.
18
-
Alternatively, instead of downloading, you can build the generator yourself by cloning this repo and running `make`.
19
-
To build yourself, you need a recent Go version, CMake and a C++11 tool chain.
18
+
19
+
## Build
20
+
21
+
If you prefer to build the generator yourself (vs. downloading), clone this repo and simply run `make`.
22
+
This will produce an "objectbox-generator" binary in the main project directory.
23
+
24
+
Build notes:
25
+
26
+
* To build yourself, you need Go, Make, CMake and a C++11 tool chain.
27
+
* To run test suite, run `make test-depend test`.
28
+
*`test-depend` needs to run only once to download objectbox core library and to build flatcc.
29
+
* A full test cycle can be triggered by `make clean all test-depend test`.
20
30
21
31
## Getting started
22
32
23
-
To get started, have a look at the projects based on your language of choice:
24
-
* C and C++ [repository](https://github.com/objectbox/objectbox-c) and [docs](https://cpp.objectbox.io/)
25
-
* Go [repository](https://github.com/objectbox/objectbox-go) and [docs](https://golang.objectbox.io/)
33
+
To get started, have a look at the specific language bindings (the approaches differ):
34
+
35
+
* C and C++ [repository](https://github.com/objectbox/objectbox-c) and [docs](https://cpp.objectbox.io/).
36
+
In summary, you define a FlatBuffers schema file, and the ObjectBox Generator will create plain C++ data classes
37
+
and helper classes that "glue" the data classes to the ObjectBox runtime library.
38
+
* Go [repository](https://github.com/objectbox/objectbox-go) and [docs](https://golang.objectbox.io/).
39
+
Here, you start with Go data structs, for which the Generator generates the glue code directly.
26
40
27
41
# License
28
42
29
43
```
30
-
Copyright (C) 2022 ObjectBox Ltd. All rights reserved.
44
+
Copyright (C) 2018-2024 ObjectBox Ltd. All rights reserved.
0 commit comments