Skip to content

Commit a429169

Browse files
authored
Drop most of the README (dart-archive#177)
We don't expect these rules to be usable today and we are not actively working towards that.
1 parent 6fd11f7 commit a429169

File tree

1 file changed

+3
-45
lines changed

1 file changed

+3
-45
lines changed

README.md

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,5 @@
11
# Dart rules
22

3-
**WARNING** These are in active development and are *not* production-ready.
4-
Expect frequent breaking changes. The only way these rules should be used is
5-
with automatically generated BUILD files which should not be checked in since
6-
they will not be stable across versions of `rules_dart`.
7-
8-
## Overview
9-
10-
These build rules are used for building [Dart][] projects with Bazel. To use the
11-
Dart rules see [bazelify][].
12-
13-
[Dart]: https://dartlang.org
14-
[bazelify]: https://github.com/dart-lang/bazel
15-
16-
## Rules
17-
18-
* dart\_library
19-
* dart\_vm\_binary
20-
* dart\_vm\_snapshot
21-
* dart\_vm\_test
22-
* dart\_web\_application
23-
* dart\_web\_test
24-
25-
26-
## Core rules
27-
28-
`dart_library`: Declares a collection of Dart sources and data and their
29-
dependencies.
30-
31-
32-
## VM rules
33-
34-
`dart_vm_binary`: Builds an executable bundle that runs a script or snapshot on
35-
the Dart VM.
36-
37-
`dart_vm_snapshot`: Builds a VM snapshot of a Dart script. **WARNING** Snapshot
38-
files are *not* guaranteed to be compatible across VM releases.
39-
40-
`dart_vm_test`: Builds a test that will be executed on the Dart VM.
41-
42-
43-
## Web rules
44-
45-
`dart_web_application`: Compiles the specified script to JavaScript.
46-
47-
`dart_web_test`: Builds a test that will be executed in the browser.
3+
**WARNING** These rules are not officially supported. Expect frequent breaking
4+
changes. Some of the rules have closed-source usages and may be updated without
5+
corrections in the open-source equivalents.

0 commit comments

Comments
 (0)