From 4bd23a330a0ef46314ca490d9707b5f6c867303f Mon Sep 17 00:00:00 2001 From: Tom Verbeure Date: Mon, 19 Jan 2026 22:20:41 -0800 Subject: [PATCH 1/3] Link to compilation instructions in the HTLM manual. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f5cc44a5..9d261902 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,16 @@ Project website: [https://www.ngscopeclient.org](https://www.ngscopeclient.org) * [Code of Conduct](https://github.com/ngscopeclient/scopehal-apps/blob/master/CODE_OF_CONDUCT.md) * We are a proudly AI-free project. Only human created code is acceptable for contribution. -## Installation +## Installation Refer to the "getting started" chapter of the User manual * [User manual GettingStarted (HTML)](https://www.ngscopeclient.org/manual/GettingStarted.html) * [User manual (PDF)](https://www.ngscopeclient.org/downloads/ngscopeclient-manual.pdf) +## Compilation instructions (Linux,macOS,Windows) + +* [User manual Compilation (HTML)](https://www.ngscopeclient.org/manual/GettingStarted.html#compilation) + ## Special comments The following standard comments are used throughout the code to indicate things that could use attention, but are From bdad38bdbbf40b62eccf00f82ac5c2c22dc8cc87 Mon Sep 17 00:00:00 2001 From: Tom Verbeure Date: Sat, 24 Jan 2026 20:02:38 -0800 Subject: [PATCH 2/3] Add instructions on how to compile a forked repo. --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index 9d261902..8a393a14 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,46 @@ Refer to the "getting started" chapter of the User manual * [User manual Compilation (HTML)](https://www.ngscopeclient.org/manual/GettingStarted.html#compilation) +## Compiling a forked repo + +If you want to contribute changes to scopehal-apps, you should make them in a +forked repo so that you can create pull request with your changes. + +Following these steps: + +* Fork a bunch of GitHub repos to your own GitHub account + + Right now, the build system requires that your GitHub account has cloned version of the + VkFFT, xptools and logtools. It's best to clone the version that under the ngscopeclient + account, this ensure that you're working with the same version as the core development + team. + + * [ngscopeclient/VkFFT](https://github.com/ngscopeclient/VkFFT) + * [ngscopeclient/xptools](https://github.com/ngscopeclient/xptools) + * [ngscopeclient/logtools](https://github.com/ngscopeclient/logtools) + +* Fork the `scopehal-apps` repo (this one!) to your own account +* Clone your personal repo to your development machine + + `git clone --recursive git@github.com:/scopehal-apps.git scopehal-apps` + +* Follow the regular compilation instructions. + + If you want to create executables with debug symbols, make sure to change option `MAKE_BUILD_TYPE` + from `Release` to `Debug` when running `cmake`. + + It is possible that `cmake` errors out with the following error messages: + + ``` +CMake Error at CMakeLists.txt:82 (message): + Unrecognized version tag 53152c7c / 53152c7c, can't create a VERSIONINFO + from it. Must be of format v1.2, v1.2.3, v1.2-rc3, v1.2.3-rc4 + ``` + + You can fix this by creating a dummy tag in your local repo: + + `git tag v0.0.0` + ## Special comments The following standard comments are used throughout the code to indicate things that could use attention, but are From 84b992421af5706ebf2ef1a97b4eb873c832d9e2 Mon Sep 17 00:00:00 2001 From: Tom Verbeure Date: Sat, 24 Jan 2026 20:05:30 -0800 Subject: [PATCH 3/3] Fix markdown formatting. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8a393a14..95800a33 100644 --- a/README.md +++ b/README.md @@ -48,17 +48,17 @@ Following these steps: If you want to create executables with debug symbols, make sure to change option `MAKE_BUILD_TYPE` from `Release` to `Debug` when running `cmake`. - It is possible that `cmake` errors out with the following error messages: +It is possible that `cmake` errors out with the following error message: - ``` +``` CMake Error at CMakeLists.txt:82 (message): Unrecognized version tag 53152c7c / 53152c7c, can't create a VERSIONINFO from it. Must be of format v1.2, v1.2.3, v1.2-rc3, v1.2.3-rc4 - ``` +``` - You can fix this by creating a dummy tag in your local repo: +You can fix this by creating a dummy tag in your local repo: - `git tag v0.0.0` +`git tag v0.0.0` ## Special comments