diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0932fd1 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# build + +[](https://results.pre-commit.ci/latest/github/pypa/build/main) +[](https://github.com/pypa/build/actions) +[](https://github.com/pypa/build/actions/workflows/test.yml) +[](https://codecov.io/gh/pypa/build) + +[](https://pypa-build.readthedocs.io/en/latest/?badge=latest) +[](https://pypi.org/project/build/) +[](https://discord.gg/pypa) + +A simple, correct PEP 517 build frontend. + +See the [documentation](https://pypa-build.readthedocs.io/en/latest/) for more information. + +### Installation + +`build` can be installed via `pip` or an equivalent via: + +```console +$ pip install build +``` + +### Usage + +```console +$ python -m build +``` + +This will build the package in an isolated environment, generating a +source-distribution and wheel in the directory `dist/`. +See the [documentation](https://pypa-build.readthedocs.io/en/latest/) for full information. + +### Code of Conduct + +Everyone interacting in the build's codebase, issue trackers, chat rooms, and mailing lists is expected to follow +the [PSF Code of Conduct]. + +[psf code of conduct]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md |