Skip to content

C
coopwire-hypothesis
Unverified Commit 34a02e45 authored by Sean Hammond's avatar Sean Hammond
Browse files
Options

Clarify browser extension vs web service

parent da9a526f
Hide whitespace changes
Inline Side-by-side
Showing with 20 additions and 7 deletions
docs/developing.md
View file @ 34a02e45
...@@ -13,9 +13,6 @@ extension](https://github.com/hypothesis/browser-extension) or setup [a local ...@@ -13,9 +13,6 @@ extension](https://github.com/hypothesis/browser-extension) or setup [a local
install of the Hypothesis install of the Hypothesis
service](http://h.readthedocs.io/en/latest/developing/) to host the client. service](http://h.readthedocs.io/en/latest/developing/) to host the client.
If you are only interested in making changes to the client, developing using
the browser extension is the easiest method.
## Prerequisites ## Prerequisites
You will need: You will need:
...@@ -32,7 +29,21 @@ sudo npm install -g gulp-cli ...@@ -32,7 +29,21 @@ sudo npm install -g gulp-cli
make make
``` ```
## Developing using the browser extension You now have a development client installed. To run your development client in
a browser you'll need a local copy of either the Hypothesis Chrome extension or
the Hypothesis web service. Follow either the instructions for
[Running the client from the browser extension](#running-the-client-from-the-browser-extension)
or for
[Running the client from the web service](#running-the-client-from-the-web-service)
below.
If you're only interested in making changes to the client (and not to the web
service) then running the client from the browser extension is easiest.
## Running the client from the browser extension
This is the currently easiest way to get your development client running in a
browser. It sets you up to make changes to the client and to the Chrome
extension itself, but not to the web service.
1. Check out the [browser 1. Check out the [browser
extension](https://github.com/hypothesis/browser-extension) and follow the extension](https://github.com/hypothesis/browser-extension) and follow the
...@@ -54,10 +65,12 @@ make ...@@ -54,10 +65,12 @@ make
Reloader](https://chrome.google.com/webstore/detail/extensions-reloader/fimgfedafeadlieiabdeeaodndnlbhid?hl=en) Reloader](https://chrome.google.com/webstore/detail/extensions-reloader/fimgfedafeadlieiabdeeaodndnlbhid?hl=en)
to make this easier. to make this easier.
If you want to use the browser extension together with a local Hypothesis ## Running the client from the web service
service for storing annotations, you should also follow the steps below.
## Developing using a local Hypothesis web service This takes longer to setup than
[Running the client from the browser extension](#running-the-client-from-the-browser-extension).
You should follow these steps if you want to make changes to the Hypothesis
web service as well as to the client.
Once you have a local install of the Hypothesis service set up, you can Once you have a local install of the Hypothesis service set up, you can
configure it to use a local build of the client. In the client repository, run: configure it to use a local build of the client. In the client repository, run:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment