Skip to content

Commit 0f7fc59

Browse files
README: instructions to run example.
1 parent 8c3a6fc commit 0f7fc59

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,23 @@ box.put(person) # Update
8383
box.remove(person) # Delete
8484
```
8585

86-
Additionally, see the [TaskList example app](https://github.com/objectbox/objectbox-python/tree/main/example).
86+
Additionally, see the [TaskList example app](https://github.com/objectbox/objectbox-python/tree/main/example). After checking out this repository to run the example:
87+
```
88+
// Set up virtual environment, download ObjectBox libraries
89+
make depend
90+
91+
// Activate virtual environment...
92+
// ...on Linux
93+
source .venv/bin/activate
94+
// ...on Windows
95+
.venv\Scripts\activate
96+
97+
// Run the example
98+
python3 -m example
99+
100+
// Once done, leave the virtual environment
101+
deactivate
102+
```
87103

88104
For more information and code examples, see the tests folder. The docs for other languages may also help you understand the basics.
89105

0 commit comments

Comments
 (0)