diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 800d92bf..e52e71c3 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -13,9 +13,6 @@ on: # Allows you to run this workflow manually from the Actions tab workflow_dispatch: -permissions: - contents: write - # Workflow run - one or more jobs that can run sequentially or in parallel jobs: # This workflow contains a single job called "build-docs" diff --git a/FTorch.md b/FTorch.md index 12ac20c1..66cad5ab 100644 --- a/FTorch.md +++ b/FTorch.md @@ -5,6 +5,7 @@ author: ICCS Cambridge license: mit github: https://github.com/Cambridge-ICCS project_github: https://github.com/Cambridge-ICCS/FTorch +page_dir: pages src_dir: ./src ./utils output_dir: ./doc diff --git a/pages/cmake.md b/pages/cmake.md new file mode 100644 index 00000000..60dd71f8 --- /dev/null +++ b/pages/cmake.md @@ -0,0 +1,61 @@ +title: CMake Build Process + +Installation of FTorch is done by CMake. + +This is controlled by the `CMakeLists.txt` file in `src/`. + +## Basic instructions + +To build the library, first clone it from github to your local machine and then run: +```bash +cd FTorch/src/ +mkdir build +cd build +``` + +Then invoke CMake with the Release build option, plus any other options as required +from the table below in [CMake build options](#cmake-build-options) +(note: you will likely _need_ to add some of these options to ): +```bash +cmake .. -DCMAKE_BUILD_TYPE=Release +``` + +Finally build and install the library: +```bash +cmake --build . --target install +``` + +## CMake build options + +It is likely that you will need to provide at least the `CMAKE_PREFIX_PATH` flag. +The following CMake flags are available and can be passed as arguments through `-D