Skip to content

Commit 2f149a0

Browse files
committed
Document dependency versions #34
1 parent 4757624 commit 2f149a0

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

readme.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,23 @@ Skribidi just got started. There are bugs and the API is very likely to change.
4949
- `mkdir build`
5050
- `cd build`
5151
- `cmake ..`
52-
- On Windows: Open and build `build/skribidi.sln`
53-
On Linux: use `cmake --build . -j$(nproc)`
54-
On macOS: use `cmake --build . -j$(sysctl -n hw.ncpu)`
52+
- Build
53+
- *Windows*: Open and build `build/skribidi.sln`
54+
- *Linux*: use `cmake --build . -j$(nproc)`
55+
- *macOS*: use `cmake --build . -j$(sysctl -n hw.ncpu)`
5556

57+
When running the example or test, the working directory should be the the binary direction (`/build/bin`). On Windows, the example data direction is copied there and on Linux or macOS there's a symlink for the data directory.
58+
59+
## Dependencies
5660
The project uses CMake, but you dont need to. If you handle dependecies yourself you can just add the
5761
`include` and `src` to your project and you're good to go. The CMake is used to fetch the right deps
5862
and to build the examples and tests, making development simpler.
5963

64+
- [Harfbuzz](https://github.com/harfbuzz/harfbuzz) - 11.0.0
65+
- [SheenBidi](https://github.com/Tehreer/SheenBidi) - 83f77108a2873600283f6da4b326a2dca7a3a7a6
66+
- [libunibreak](https://github.com/adah1972/libunibreak) - libunibreak_6_1.zip
67+
- [budouxc](https://github.com/memononen/budouxc) - a044d49afc654117fac7623fff15bec15943270c
68+
6069
## License
6170
Skribidi is developed by Mikko Mononen and uses the [MIT license](https://en.wikipedia.org/wiki/MIT_License).
6271

0 commit comments

Comments
 (0)