diff options
author | nyquist <nyquist@chromium.org> | 2015-09-21 08:58:50 -0700 |
---|---|---|
committer | Commit bot <commit-bot@chromium.org> | 2015-09-21 15:59:25 +0000 |
commit | ba0c914038ce8aac2e1bf6248d160cf4f9eff99c (patch) | |
tree | 39d548829d0bdf928d013b9b459e608dbbf9dd83 /blimp | |
parent | 6ced5d624c786faee2d6adb502f0eff4cf1d9572 (diff) | |
download | chromium_src-ba0c914038ce8aac2e1bf6248d160cf4f9eff99c.zip chromium_src-ba0c914038ce8aac2e1bf6248d160cf4f9eff99c.tar.gz chromium_src-ba0c914038ce8aac2e1bf6248d160cf4f9eff99c.tar.bz2 |
Change blimp README to use Markdown.
Going forward, the README.md and linked documents will be the
main source of developer documentation. The top-level
README.md will link to sections focused on items like building,
testing, etc.
BUG=None
Review URL: https://codereview.chromium.org/1353593002
Cr-Commit-Position: refs/heads/master@{#349935}
Diffstat (limited to 'blimp')
-rw-r--r-- | blimp/README | 1 | ||||
-rw-r--r-- | blimp/README.md | 7 | ||||
-rw-r--r-- | blimp/docs/build.md | 50 |
3 files changed, 57 insertions, 1 deletions
diff --git a/blimp/README b/blimp/README deleted file mode 100644 index 9f8c654..0000000 --- a/blimp/README +++ /dev/null @@ -1 +0,0 @@ -Blimp is an experimental project for building Chromium as a thin client.
\ No newline at end of file diff --git a/blimp/README.md b/blimp/README.md new file mode 100644 index 0000000..5833b9d --- /dev/null +++ b/blimp/README.md @@ -0,0 +1,7 @@ +# Blimp + +Blimp is an experimental project for building Chromium as a thin client. + +## Engineering + +For building blimp, read more at [building](docs/build.md). diff --git a/blimp/docs/build.md b/blimp/docs/build.md new file mode 100644 index 0000000..b29b5ff --- /dev/null +++ b/blimp/docs/build.md @@ -0,0 +1,50 @@ +# Using GN +Blimp only supports building using [GN](../../tools/gn/README.md), and only +supports building for Android and Linux. A quick overview over how to use GN can +be found in the GN [quick start guide](../../tools/gn/docs/quick_start.md). + +## Android setup +To setup GN, run the following command: +``` +gn args out-android/Debug +``` +This will bring up an editor, where you can type in the following: + +``` +target_os = "android" +is_debug = true +is_clang = true +is_component_build = true +symbol_level = 1 # Use -g1 instead of -g2 +use_goma = true +``` + +## Linux setup +For building for Linux, you can have a side-by-side out-directory: +``` +gn args out-linux/Debug +``` +Use the same arguments as above, but remove `target_os`. +``` +is_debug = true +is_clang = true +is_component_build = true +symbol_level = 1 # Use -g1 instead of -g2 +use_goma = true +``` + +# Building + +To build blimp, build the target ```blimp```. + +## Building for Android + +``` +ninja -C out-android/Debug blimp +``` + +## Building for Linux + +``` +ninja -C out-linux/Debug blimp +``` |