diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..158a728 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,23 @@ +# Development + +## Setup + +Install git hooks: + +```bash +pre-commit install +``` + +## Release + +Build all release artifacts: + +```bash +./scripts/release/build.sh +``` + +Create release notes: + +```bash +./scripts/release/notes.sh +``` diff --git a/README.md b/README.md index 8e2f5c3..5793a2b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ # Bazel Rules for QuickJS [![Test](https://github.com/bzlparty/rules_quickjs/actions/workflows/test.yaml/badge.svg?branch=main&event=push)](https://github.com/bzlparty/rules_quickjs/actions/workflows/test.yaml) +[![Release](https://img.shields.io/github/v/release/bzlparty/rules_quickjs?label=Release)](https://github.com/bzlparty/rules_quickjs/releases/latest) This project brings [quickjs-ng/quickjs](https://github.com/quickjs-ng/quickjs) to Bazel! Inspired by (and based on) [rules_js](https://github.com/aspect-build/rules_js), it lets you run JavaScript with `qjs` under Bazel. -> [!NOTE] -> Since the archives taken from quickjs-ng only include the interpreter binary, there is no support for the QuickJS compiler (`qjsc`), yet. - ## Installation See install instructions on the [release page](https://github.com/bzlparty/rules_quickjs/releases). @@ -25,7 +23,7 @@ qjs_binary( ) ``` -See the [documentation](/docs/qjs.md) for more details. +See the [rules documentation](/docs/rules.md) for more details. Run `qjs` from Bazel: @@ -33,14 +31,10 @@ Run `qjs` from Bazel: bazel run @bzlparty_quickjs//:qjs ``` -## Development - -Install git hooks: +## License -```bash -pre-commit install -``` +Copyright Contributors to the bzlparty project. -## License +Unless otherwise specified, source code in this repository is licensed under the GNU Lesser General Public License, Version 3 or later (LGPL-3.0-or-later). A copy is included in the `LICENSE` file. -[GNU LGPL 3.0](/LICENSE) +Other licenses may be specified as well for certain files or where third-party components are used.