Skip to content

Commit

Permalink
docs(readme): add integration section
Browse files Browse the repository at this point in the history
  • Loading branch information
threeal committed Apr 24, 2024
1 parent a7bd229 commit a627a56
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,28 @@ The `SetupGo.cmake` is a CMake module containing a `setup_go` function.
This function sets up a specific version of Go to be used in a CMake project.
It downloads a specific Go build based on the current operating system and architecture from the official Go website and extracts the downloaded result to the CMake build directory.

## Integration

This module can be integrated into a CMake project in the following ways:

- Manually download the [`SetupGo.cmake`](./cmake/SetupGo.cmake) file and include it in the CMake project:
```cmake
include("path/to/SetupGo.cmake")
```
- Use [`file(DOWNLOAD)`](https://cmake.org/cmake/help/latest/command/file.html#download) to automatically download the `GitCheckout.cmake` file:
```cmake
file(
DOWNLOAD "https://threeal.github.io/setup-go-cmake/v1.0.0"
"${CMAKE_BINARY_DIR}/SetupGo.cmake"
)
include("${CMAKE_BINARY_DIR}/SetupGo.cmake")
```
- Use [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake) to add this package to the CMake project:
```cmake
cpmaddpackage("gh:threeal/setup-go-cmake@1.0.0")
include("${SetupGo_SOURCE_DIR}/cmake/SetupGo.cmake")
```

## License

This project is licensed under the terms of the [MIT License](./LICENSE).
Expand Down

0 comments on commit a627a56

Please sign in to comment.