From 1e245118267ccf3c6a61a99b82b6691ff9ea69f6 Mon Sep 17 00:00:00 2001
From: Sam Gammon <sam@elide.ventures>
Date: Sat, 12 Aug 2023 23:50:02 -0700
Subject: [PATCH] chore: add doc index page

---
 docs/index.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 85 insertions(+)
 create mode 100644 docs/index.md

diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 00000000..39dafdcc
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,85 @@
+
+# GraalVM Rules for Bazel
+
+These rules let you use [GraalVM](https://graalvm.org) from Bazel, with support for:
+
+- [Building native image binaries](./docs/native-image.md)
+- [Installing components with `gu`](./docs/components.md)
+- [Using GraalVM as a Bazel Java toolchain](./docs/toolchain.md)
+- [Support for Bazel 6, Bazel 7, and Bzlmod](./docs/modern-bazel.md)
+- Support for macOS, Linux, Windows
+- Support for latest modern GraalVM releases (Community Edition and Oracle GraalVM)
+
+## Installation
+
+**Via `WORKSPACE`:**
+```starlark
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+http_archive(
+    name = "rules_graalvm",
+    sha256 = "<sha256 sum>",
+    strip_prefix = "rules_graalvm-<commit>",
+    urls = [
+        "https://github.com/sgammon/rules_graalvm/archive/<commit>.tar.gz",
+    ],
+)
+
+load("@rules_graalvm//graalvm:repositories.bzl", "graalvm_repository")
+
+graalvm_repository(
+    name = "graalvm",         # anything you want
+    version = "20.0.1",       # exact version of a GraalVM CE or Oracle GVM release
+    distribution = "oracle",  # required for newer GVM releases (`oracle`, `ce`, or `community`)
+    java_version = "20",      # java language version to use/declare
+)
+```
+
+**Via `MODULE.bazel`:**
+```starlark
+# Coming soon.
+```
+
+## Usage
+
+These rules are [documented](https://sgammon.github.io/rules_graalvm); you can find important docs at these links:
+
+- [`graalvm_repository`](./api/repositories.md): Declaring and consuming a GraalVM installation
+- [`native_image`](./api/defs.md): Building a GraalVM `native-image` from Java code
+
+### Java Toolchains
+
+You can use the `graalvm_repository` as a Java toolchain, by registering it like below:
+
+**In `WORKSPACE.bazel`:**
+```starlark
+# Coming soon.
+```
+
+**Or, in a `.bazelrc` file:**
+```
+# Coming soon.
+```
+
+### Build a native binary
+
+**In a `BUILD.bazel` file:**
+```python
+load("@rules_java//java:defs.bzl", "java_library")
+load("@rules_graalvm//graalvm:defs.bzl", "native_image")
+
+java_library(
+    name = "main",
+    srcs = glob(["Main.java"]),
+)
+
+native_image(
+    name = "main-native",
+    deps = [":main"],
+    main_class = "Main",
+)
+```
+
+## Acknowledgements
+
+Built on top of @andyscott's fantastic work with [rules_graal](https://github.com/andyscott/rules_graal).