Skip to content

Commit 0ade066

Browse files
committed
feat: Update readme
1 parent f02d681 commit 0ade066

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,23 @@
1616
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how can you help the project and how to provide information so we can help you in case of troubles with the app.
1717

1818
## Building Manually
19-
Application uses `vcpkg` to manage its dependencies and `cmake` as its build system.
19+
Application uses `cmake` as its build system and `vcpkg` to *optionally* manage its dependencies.
2020

21-
Ensure both `vcpkg` and `cmake` are installed on your system before building.
21+
Ensure `cmake` and `vcpkg` are installed on your system before building and installing Application.
2222

2323
A C++20 compiler is also required to build Application.
2424

25-
**If building the Linux version, `blueprint-compiler` must be installed from your system package manager as it is not available on `vcpkg`.**
25+
### Dependencies
26+
The following are a list of dependencies used by Application.
27+
28+
The recommendation is to (and below commands will) use vcpkg to pull these dependencies. However, vcpkg is not a requirement as long as the system provides these dependencies correctly.
29+
30+
#### All Platforms
31+
- `libnick`
32+
33+
#### Linux
34+
- `blueprint-compiler` (Not available from vcpkg)
35+
- `libxmlpp`
2636

2737
### Configuring vcpkg
2838
1. Set the `VCPKG_ROOT` environment variable to the path of your vcpkg installation's root directory.

0 commit comments

Comments
 (0)