aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorc-parsons <cparsons@google.com>2019-02-28 17:43:57 -0500
committerGitHub <noreply@github.com>2019-02-28 17:43:57 -0500
commit9630853eebaee22d8799f97ab58f648a1b82d02d (patch)
treeceb6c78087d99934605d568b734b99a38269569f /README.md
parente171ec16d89afe28d09d29837ce523aa10aebdc6 (diff)
downloadbazel-skylib-9630853eebaee22d8799f97ab58f648a1b82d02d.tar.gz
add documentation pages for rules/ and lib/ (#119)
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 14 insertions, 12 deletions
diff --git a/README.md b/README.md
index 6f82d96..14066e9 100644
--- a/README.md
+++ b/README.md
@@ -56,22 +56,24 @@ s = shell.quote(p)
## List of modules (in lib/)
-* [collections](lib/collections.bzl)
-* [dicts](lib/dicts.bzl)
-* [partial](lib/partial.bzl)
-* [paths](lib/paths.bzl)
-* [selects](lib/selects.bzl)
+* [collections](docs/collections_doc.md)
+* [dicts](docs/dicts_doc.md)
+* [partial](docs/partial_doc.md)
+* [paths](docs/paths_doc.md)
+* [selects](docs/selects_doc.md)
* [sets](lib/sets.bzl) - _deprecated_, use `new_sets`
-* [new_sets](lib/new_sets.bzl)
-* [shell](lib/shell.bzl)
-* [structs](lib/structs.bzl)
-* [types](lib/types.bzl)
-* [unittest](lib/unittest.bzl)
-* [versions](lib/versions.bzl)
+* [new_sets](docs/new_sets.md)
+* [shell](docs/shell_doc.md)
+* [structs](docs/structs_doc.md)
+* [types](docs/types_doc.md)
+* [unittest](docs/unittest_doc.md)
+* [versions](docs/versions_doc.md)
## List of rules (in rules/)
-* [`cmd_maprule` and `bash_maprule`](lib/maprule.bzl)
+* [analysis_test](docs/analysis_test_doc.md)
+* [build_test](docs/build_test_doc.md)
+* [`cmd_maprule` and `bash_maprule`](docs/maprule_doc.md)
## Writing a new module