Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1600)

Unified Diff: mojo/devtools/common/README.md

Issue 1158323008: Expand the devtools/common readme. (Closed) Base URL: git@github.com:domokit/mojo.git@master
Patch Set: Address Tony's comments. Created 5 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: mojo/devtools/common/README.md
diff --git a/mojo/devtools/common/README.md b/mojo/devtools/common/README.md
index 07d6db82f566cfaa232a895dfb7b0d53e4a00151..2e06256a89ecc13abef6659c28b86cb229452d1e 100644
--- a/mojo/devtools/common/README.md
+++ b/mojo/devtools/common/README.md
@@ -2,8 +2,39 @@
Unopinionated tools for **running**, **debugging** and **testing** Mojo apps.
+The repo consists of:
+
+ - **devtoolslib** - Python module containing the core scripting functionality
+ for running Mojo apps: shell abstraction with implementations for Android and
+ Linux and support for apptest frameworks
+ - executable scripts - example embedders of devtoolslib and other utils
+
+## Embedding devtoolslib
+
+As devtools carry no assumptions about build system or file layout being used,
+the primary way of using devtools now is to embed the functionality provided by
+**devtoolslib** in a thin wrapper script. For examples, one can refer to mojo's
+[shell
+runner](https://github.com/domokit/mojo/blob/master/mojo/tools/mojo_shell.py)
+and [apptest
+runner](https://github.com/domokit/mojo/blob/master/mojo/tools/apptest_runner.py).
+
+## Executable scripts
+
+The set of executable scripts is WIP. We currently offer:
+
+ - **debugger** - allowing to send commands to the mojo:debugger app running in
+ the shell, allowing e.g. to interactively start and stop tracing
+
## Install
```
git clone https://github.com/domokit/devtools.git
```
+
+## File location
+
+The library is canonically developed [in the mojo
+repository](https://github.com/domokit/mojo/tree/master/mojo/devtools/common),
+https://github.com/domokit/devtools is a mirror allowing to consume it
+separately.
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698