Skip to content

Commit

Permalink
docs: update README (#60)
Browse files Browse the repository at this point in the history
  • Loading branch information
henryiii authored Oct 25, 2024
1 parent 1926e31 commit aef4790
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ include(UseCython)

If you find Python beforehand, the search will take this into account. You can
specify a version range on CMake 3.19+. This will define a `Cython::Cython`
target (along with a matching `CYTHON_EXECUTABLE` variable). It will also
provide the following helper function:
target (along with a matching `CYTHON_EXECUTABLE` variable). The UseCython
module will provide the following helper function:

```cmake
cython_transpile(<pyx_file>
Expand Down Expand Up @@ -57,11 +57,12 @@ find_package(
Python
COMPONENTS Interpreter Development.Module
REQUIRED)
find_package(Cython MODULE REQUIRED)
include(UseCython)
cython_transpile(simple.pyx LANGUAGE C OUTPUT_VARIABLE simple_c)
python_add_library(simple MODULE "${simple_c}" WITH_SOABI)
install(TARGETS simple DESTINATION .)
```

## scikit-build-core
Expand All @@ -75,12 +76,7 @@ requires = ["scikit-build-core", "cython", "cython-cmake"]
build-backend = "scikit_build_core.build"
```

It is also recommended to require CMake 3.21:

```toml
[tool.scikit-build]
cmake.version = ">=3.21"
```
It is also recommended to require CMake 3.21 or newer in your `CMakeLists.txt`.

## Vendoring

Expand Down

0 comments on commit aef4790

Please sign in to comment.