aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 19 insertions, 12 deletions
diff --git a/README b/README
index b61ae6ed..e49186be 100644
--- a/README
+++ b/README
@@ -1,15 +1,22 @@
-The src directory contains Chromium source from the following locations:
+The trace-viewer directory contains code from:
- http://src.chromium.org/chrome/trunk/src/chrome/browser/resources/shared/
- http://src.chromium.org/chrome/trunk/src/chrome/browser/resources/tracing/
+ http://trace-viewer.googlecode.com/svn/trunk/
-The file src/UPSTREAM_REVISION contains the upstream revision number that was
-last pulled. There may be local patches applied on top of the upstream source,
-but we should keep those to a minimum.
+The file UPSTREAM_REVISION contains the upstream revision number that was last
+pulled. Changes should be made upstream and then pulled into the trace-viewer
+directory.
+
+The update.py script should be used to pull the latest upstream code, update
+the UPSTREAM_REVISION file, and package the CSS and Javascript files into
+style.css and script.js, respectively. These generated files are being checked
+into the git repository, and they get embedded in each trace HTML file that
+systrace.py generates.
+
+To make development of trace-viewer code in the context of systrace easier,
+systrace supports arguments to generate HTML files that link to files in a
+trace-viewer development directory rather than embedding the JS and CSS in the
+HTML. Do take advantage of this, you should check out the trace-viewer code in
+a new directory (e.g. trace-viewer-dev) and use systrace as follows:
+
+ $ ./systrace.py --link-assets --asset-dir trace-viewer-dev
-The update.py script should be used to package the CSS and Javascript files in
-the src directory into the style.css and script.js files. These files are
-being checked in, and get embedded in each trace HTML file the systrace.py
-generates. Each time a file in the www directory gets updated, this script
-will need to be rerun, and the generated files must be committed along with the
-changes to the www directory.