Skip to content

Commit b9e64bb

Browse files
committed
docs: prepare for 0.1.0
Signed-off-by: Henry Schreiner <[email protected]>
1 parent 3e6ad7c commit b9e64bb

File tree

2 files changed

+30
-23
lines changed

2 files changed

+30
-23
lines changed

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# scikit-build-core
22

33
[![Actions Status][actions-badge]][actions-link]
4-
[![Documentation Status][rtd-badge]][rtd-link]
54
[![Code style: black][black-badge]][black-link]
65
[![codecov][codecov-badge]][codecov-link]
6+
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
77

8-
<!-- Not implemented yet
98
[![PyPI version][pypi-version]][pypi-link]
10-
[![Conda-Forge][conda-badge]][conda-link]
119
[![PyPI platforms][pypi-platforms]][pypi-link]
1210

13-
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
11+
<!-- Not implemented yet
12+
[![Documentation Status][rtd-badge]][rtd-link]
13+
[![Conda-Forge][conda-badge]][conda-link]
1414
[![Gitter][gitter-badge]][gitter-link]
1515
-->
1616

@@ -19,6 +19,21 @@ is experimental and likely to move to a separate package), and internal API is
1919
still being solidified. A future version of this package will support creating
2020
new build extensions.
2121

22+
Features over classic Scikit-build:
23+
24+
- Better warnings, errors, and logging
25+
- No warning about unused variables
26+
- Automatically adds Ninja and/or CMake only as required
27+
- No dependency on setuptools, distutils, or wheel in build mode.
28+
- Powerful config system, including config options support in build mode.
29+
- Automatic inclusion of site-packages in `CMAKE_PREFIX_PATH`
30+
- FindPython is backported if running on CMake < 3.24 (included via hatchling in
31+
a submodule, configurable)
32+
- Limited API / Stable ABI and pythonless tags supported via config option
33+
- No slow generator search, ninja/make or MSVC used by default, respects
34+
`CMAKE_GENERATOR`
35+
- SDists are reproducible by default (UNIX, Python 3.9+)
36+
2237
The following limitations are present compared to classic scikit-build:
2338

2439
- The minimum supported CMake is 3.15
@@ -36,26 +51,11 @@ Some known missing features that will be developed soon:
3651

3752
Other backends are also planned:
3853

39-
- Setuptools integration highly experimental currently
54+
- Setuptools integration highly experimental
4055
- The extensionlib integration is missing
4156
- No hatchling plugin yet
4257

43-
Features over classic Scikit-build:
44-
45-
- Better warnings, errors, and logging
46-
- No warning about unused variables
47-
- Automatically adds Ninja and/or CMake only as required
48-
- No dependency on setuptools, distutils, or wheel in build mode.
49-
- Powerful config system, including config options support in build mode.
50-
- Automatic inclusion of site-packages in `CMAKE_PREFIX_PATH`
51-
- FindPython is backported if running on CMake < 3.24 (included via hatchling in
52-
a submodule, configurable)
53-
- Limited API / Stable ABI and pythonless tags supported via config option
54-
- No slow generator search, ninja/make or MSVC used by default, respects
55-
`CMAKE_GENERATOR`
56-
- SDists are reproducible by default (UNIX, Python 3.9+)
57-
58-
Currently, the recommended interface is the PEP 517 interface. There is also a
58+
The recommended interface is the PEP 517 interface. There is also a
5959
setuptools-based interface that is being developed to provide a transition path
6060
for classic scikit-build.
6161

@@ -199,7 +199,7 @@ Support for this work was provided by NSF cooperative agreement [OAC-2209877][].
199199
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/scikit-build-core
200200
[conda-link]: https://github.com/conda-forge/scikit-build-core-feedstock
201201
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
202-
[github-discussions-link]: https://github.com/scikit-build/scikit-build-core/discussions
202+
[github-discussions-link]: https://github.com/orgs/scikit-build/discussions
203203
[gitter-badge]: https://badges.gitter.im/https://github.com/scikit-build/scikit-build-core/community.svg
204204
[gitter-link]: https://gitter.im/https://github.com/scikit-build/scikit-build-core/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
205205
[codecov-badge]: https://codecov.io/gh/scikit-build/scikit-build-core/branch/main/graph/badge.svg?token=ZLbQzIvyG8
@@ -209,6 +209,5 @@ Support for this work was provided by NSF cooperative agreement [OAC-2209877][].
209209
[pypi-version]: https://badge.fury.io/py/scikit-build-core.svg
210210
[rtd-badge]: https://readthedocs.org/projects/scikit-build-core/badge/?version=latest
211211
[rtd-link]: https://scikit-build-core.readthedocs.io/en/latest/?badge=latest
212-
[sk-badge]: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
213212
[OAC-2209877]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=2209877&HistoricalAwards=false
214213
<!-- prettier-ignore-end -->

docs/changelog.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Changelog
22

3+
## Version 0.1.0
4+
5+
First non-prerelease! Scikit-build-core is ready to be used. The remaining
6+
limitations (like support for editable mode and build caching) will be addressed
7+
in future releases. If you set `tool.scikit-build.minimum-version = "0.1"`,
8+
scikit-build-core will try to respect old defaults when new versions are
9+
released.
10+
311
## Version 0.1.0rc2
412

513
Still preparing for release. One small addition to the error printout.

0 commit comments

Comments
 (0)