aboutsummaryrefslogtreecommitdiffhomepage
path: root/site/docs/getting-started.md
diff options
context:
space:
mode:
authorGravatar Kristina Chodorow <kchodorow@google.com>2015-04-06 15:54:03 +0000
committerGravatar John Field <jfield@google.com>2015-04-06 18:48:41 +0000
commit06f446a697d9f0eefad3b5e5bf070a751e3c5efc (patch)
tree87c4129b95a28fffe55d8cc0ee80018b51e4a0a9 /site/docs/getting-started.md
parent9cc361cbab0427a27e39f92596083ebf5e20847e (diff)
Update getting started instructions with .bazelrc strategy
-- MOS_MIGRATED_REVID=90418845
Diffstat (limited to 'site/docs/getting-started.md')
-rw-r--r--site/docs/getting-started.md41
1 files changed, 5 insertions, 36 deletions
diff --git a/site/docs/getting-started.md b/site/docs/getting-started.md
index 23632974f2..f0e8bf1869 100644
--- a/site/docs/getting-started.md
+++ b/site/docs/getting-started.md
@@ -5,17 +5,12 @@ layout: default
Getting Started with Bazel
==========================
-Prerequisites
--------------
-
-Be sure you have installed all of the prerequisites for your platform, as
-outlined in the [installation instructions](install.html).
-
Setup
-----
To use Bazel, first clone the [Github repo](https://github.com/google/bazel)
-and build Bazel:
+and build Bazel (follow the instructions in the [README](install.html) to install
+prerequisites):
```bash
$ git clone https://github.com/google/bazel.git
@@ -24,9 +19,6 @@ $ ./compile.sh
```
`./compile.sh` creates the `bazel` executable in `output/bazel`.
-It also pre-populates a `base_workspace/` subdirectory with the tools
-Bazel needs to do builds, which you can copy and use as a starting
-point for new workspaces.
_**Note:** Bazel may support a binary installation at a later time._
@@ -45,31 +37,8 @@ One workspace can be shared among multiple projects, if desired. To get
started, we'll focus on a simple example with one project.
Suppose that you have an existing project in a directory, say,
-`~/gitroot/my-project/`. Copy `base_workspace/` (produced
-by `compile.sh`) and all of its contents to wherever you'd like your
-build root and then move `my-project/` to be a subdirectory of
-`base_workspace/`:
-
-```bash
-$ cp -R ~/gitroot/bazel/base_workspace ~/gitroot
-$ mv ~/gitroot/my-project ~/gitroot/base_workspace
-```
-
-At this point, you should have the following directory structure:
-
-```
-base_workspace/
- examples/
- my-project/
- tools/
- third_party/
- WORKSPACE
-```
-
-You can rename `base_workspace/` to something more descriptive, if you prefer.
-The `tools/` and `third_party/` directories can be symbolically linked into the
-workspace, or they can be copied in whole, but must be named `tools/` and
-`third_party/` respectively.
+`~/gitroot/my-project/`. Create an empty file at
+`~/gitroot/my-project/WORKSPACE` to show Bazel where your project's root is.
Sanity Check: Building an Example
---------------------------------
@@ -78,7 +47,7 @@ To make sure everything is set up correctly in your build root, build one of the
examples from the `examples/` directory.
```bash
-$ cd ~/gitroot/base_workspace
+$ cd ~/gitroot/my-project
$ bazel build examples/java-native/src/main/java/com/example/myproject:hello-world
Extracting Bazel installation...
...........