Skip to content

Commit aef4790

Browse files
authored
docs: update README (#60)
1 parent 1926e31 commit aef4790

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ include(UseCython)
2424

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

3030
```cmake
3131
cython_transpile(<pyx_file>
@@ -57,11 +57,12 @@ find_package(
5757
Python
5858
COMPONENTS Interpreter Development.Module
5959
REQUIRED)
60-
find_package(Cython MODULE REQUIRED)
60+
include(UseCython)
6161
6262
cython_transpile(simple.pyx LANGUAGE C OUTPUT_VARIABLE simple_c)
6363
6464
python_add_library(simple MODULE "${simple_c}" WITH_SOABI)
65+
install(TARGETS simple DESTINATION .)
6566
```
6667

6768
## scikit-build-core
@@ -75,12 +76,7 @@ requires = ["scikit-build-core", "cython", "cython-cmake"]
7576
build-backend = "scikit_build_core.build"
7677
```
7778

78-
It is also recommended to require CMake 3.21:
79-
80-
```toml
81-
[tool.scikit-build]
82-
cmake.version = ">=3.21"
83-
```
79+
It is also recommended to require CMake 3.21 or newer in your `CMakeLists.txt`.
8480

8581
## Vendoring
8682

0 commit comments

Comments
 (0)