diff options
| author | xengineering <me@xengineering.eu> | 2026-05-24 11:29:38 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2026-05-24 11:29:38 +0200 |
| commit | 5a0e9472d28961b2a8d598165e05f4221171c1a1 (patch) | |
| tree | b0e073a014e0722d77bbe367339667a58b09a3ea /README.md | |
| parent | 57b275d398b14aed86a047a829427c557018b5f8 (diff) | |
| download | finserv-5a0e9472d28961b2a8d598165e05f4221171c1a1.tar finserv-5a0e9472d28961b2a8d598165e05f4221171c1a1.tar.zst finserv-5a0e9472d28961b2a8d598165e05f4221171c1a1.zip | |
README.md: Add build instructions
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
@@ -1,3 +1,41 @@ # finserv Local server for financial data. + +## Build instructions + +Only builds on Linux are supported. The Git [1] Meson build system [2] has to be +installed. + +The source is retrieved with `git`. + +``` +git clone https://cgit.xengineering.eu/finserv +cd finserv +git submodule init +git submodule update +``` + +The build folder needs to be inside the source, needs to be named `build` and +is set up with `meson setup`. + +``` +meson setup build +``` + +A build is executed with `meson compile`. Missing software tools are reported +by Meson and must be installed for the build to succeed. + +``` +meson compile -C build +``` + +After a successful build the server executable can be started. The localhost +URL to access it is printed to the console. + +``` +./build/finserv-linux-amd64 +``` + +[1]: https://git-scm.com/ +[2]: https://mesonbuild.com/ |