Commit f0b8597fc7bf8873ffaeadea5c7d922154eaebda

Authored by Harshad RJ
1 parent 3393642a

Improve the grammar in README

Showing 1 changed file with 15 additions and 15 deletions   Show diff stats
README.md
... ... @@ -7,18 +7,18 @@ There is a Grunt script for building JavaPoly. So for building you have to insta
7 7 $ npm install -g grunt-cli
8 8 ```
9 9  
10   -After this install all needed packages and type:
  10 +Now install all required packages by typing:
11 11 ```sh
12 12 $ npm install
13 13 ```
14 14  
15   -For building JavaPoly browser version only run command:
  15 +For building JavaPoly "browser version" the command is:
16 16 ```sh
17 17 $ grunt build:browser
18 18 ```
19 19  
20   -This creates `build/javapoly.js` file.
21   -The javapoly.js will auto-load the js library needed(browserjs.js, doppio lib and so on) from external site(eg, www.javapoly.com)
  20 +This creates `build/javapoly.js` file. This file when included in a web-page, will auto-load some js libraries
  21 +(browserjs.js, doppio lib and so on) from external site(eg, www.javapoly.com).
22 22  
23 23 You can create complete package (including JavaPoly-Node-Doppio, JavaPoly-Node-SystemJVM) by running command:
24 24 ```sh
... ... @@ -32,15 +32,14 @@ or
32 32 $ ./node_modules/mocha/bin/mocha test/TestJavaPolyNodeSystem.js
33 33 ```
34 34  
  35 +### Developing JavaPoly
35 36  
36   -### Development JavaPoly
37   -
38   -To develop JavaPoly you have to run command:
  37 +When developing JavaPoly, you can compile the code with:
39 38 ```sh
40 39 $ grunt watch
41 40 ```
42 41  
43   -This command runs watching process that updates build-file when you change any js-file in src-folder.
  42 +This command starts a watching process that updates the build when you change any js-file in src-folder.
44 43  
45 44 ### Testing JavaPoly
46 45  
... ... @@ -58,9 +57,9 @@ You can also rebuild JavaPoly for testing without watching by command:
58 57 $ grunt build:test
59 58 ```
60 59  
61   -**note, the final javapoly.js file which build:test task generate is a little different from the file which build:browser task generate.
62   -the javapoly.js which build:test task generate will load the doppio and browserjs library in local folders.
63   -and the javapoly.js which build:browser(or build) task generate will load the doppio and browserjs library from external web site.**
  60 +**note, the final javapoly.js file which build:test task generates is a little different from the file which build:browser task generate.
  61 +the javapoly.js which build:test task generates will load the doppio and browserjs library in local folders.
  62 +and the javapoly.js which build:browser(or build) task generates will load the doppio and browserjs library from external web site.**
64 63  
65 64 To test JavaPoly you should run HTTP server for folder `test` and open `index.html` in browser.
66 65  
... ... @@ -79,12 +78,13 @@ $ npm install -g mocha
79 78  
80 79 And type `mocha` in projects directory.
81 80  
82   -### Using JavaPoly Core(include JVM) in WebWorker
  81 +### Using JavaPoly Core(including JVM) in WebWorker
  82 +
  83 +To avoid blocking the browser's main thread we can use webworkers if the browser supports it (most current browsers do).
83 84  
84   -we could use webworkers if possible(the browser support) , to avoid blocking the main thread.
  85 +This can be enabled by adding a `worker` option in javapoly.
85 86  
86   -simply add a worker options in javapoly.
87   -The options value is the url of the javapoly_worker.js.(default value is null for not using webworkers)
  87 +The value should be set to the url that points to the `javapoly_worker.js`. (default value is null which disables webworkers)
88 88  
89 89 eg.
90 90  
... ...