Chromium Code Reviews| Index: tools/chrome_extensions/open_my_editor/README.md |
| diff --git a/tools/chrome_extensions/open_my_editor/README.md b/tools/chrome_extensions/open_my_editor/README.md |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..109b41da0a100287639344373e365f610b5cc28f |
| --- /dev/null |
| +++ b/tools/chrome_extensions/open_my_editor/README.md |
| @@ -0,0 +1,51 @@ |
| +# Open My Editor (OME) |
| + |
| +OME is an enhance tools for [Chromium Code Search](https://cs.chromium.org/), |
|
watk
2017/03/02 23:13:49
"OME gives you a context menu for opening files in
|
| +[Chromium Code Review](https://codereview.chromium.org/) and |
| +[Chromium Build](https://build.chromium.org). |
| + |
| +For Chromium Code Search, right click on code block and select `OME`, it will |
|
watk
2017/03/02 23:13:49
"on a code block"
OME -> "Open my editor"
|
| +open the file in your editor with line number. |
|
watk
2017/03/02 23:13:49
"at the selected line."
|
| + |
| + |
| + |
| +For chromium Code Search, right click on symbol or filename and select |
|
watk
2017/03/02 23:13:48
capitalize Chromium
|
| +`OME by link` can also open file(maybe with linenumber). |
|
watk
2017/03/02 23:13:48
Space before open paren.
|
| + |
| + |
| + |
| +For Chromium Code Review, right click on the patchset table and select `OME`, |
| +it will open all the files in this patchset. |
|
watk
2017/03/02 23:13:48
"this patchset" -> "the patchset"
|
| + |
| + |
| + |
| +For Chromium Code Review, you can also right click on filename and select |
|
watk
2017/03/02 23:13:49
"on a filename"
|
| +`OME by link`. |
| + |
| + |
| + |
| +For any *.chromium.org site, select the file path then right click and select |
|
watk
2017/03/02 23:13:49
Remove double space before *.chromium.org
|
| +`OME $file`. |
| + |
| +## Installation |
| + |
| +1. Install the Chrome Extension `TODO will add link` |
|
watk
2017/03/02 23:13:48
Finish todo now?
|
| +2. Install dependencies `pip install bottle sh`, you may need to install |
| + `python` and `python-pip` if you don't have `pip`. |
| + |
| +3. Start `omed.py` |
| + |
| + ``` |
| + git clone sso://user/chaopeng/ome ~/ome |
|
watk
2017/03/02 23:13:49
Change this to the Chrome checkout version.
|
| + python ~/ome/omed.py # you should set it on startup |
|
watk
2017/03/02 23:13:49
I would move this comment out of the code block in
|
| + ``` |
| + |
| +4. Create your `myeditor` as your editor's wrapper (see `myeditor-example/`) and |
|
watk
2017/03/02 23:13:49
"Create a `myeditor` executable to be used for lau
|
| + put it into path. |
| +5. Enjoy. |
| + |
| +## How it works |
| + |
| +In the Chrome Extension, I read the filepath and line number from right click, |
| +then make a http call to `omed.py`. `omed.py` call `myeditor` to open your |
|
watk
2017/03/02 23:13:48
"`omed.py` calls `myeditor`"
|
| +editor. |