Skip to content

Commit 1a5e486

Browse files
grvsachdevaMarkusBordihn
authored andcommitted
fixes in doc, build.md and readme.md (#191)
1 parent 6a1b3f4 commit 1a5e486

File tree

10 files changed

+28
-28
lines changed

10 files changed

+28
-28
lines changed

BUILD.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ What you need to build the Coding with Chrome App
99
In order to build the Coding with Chrome App, you only need to have Node.js/npm,
1010
git and Open JDK / Java JRE installed on your system.
1111

12-
Each build is cross platform compatible. Which mean if you build the
12+
Each build is cross-platform compatible. Which mean if you build the
1313
Coding with Chrome App on Windows you could use the generated code
1414
`genfiles/chrome_app` folder in other platforms like Mac OS X as well.
1515

@@ -62,7 +62,7 @@ cd coding-with-chrome
6262

6363
### Init / update submodules
6464

65-
In some cases you need to init and update the submodules manually by:
65+
In some cases, you need to init and update the submodules manually by:
6666

6767
```bash
6868
git submodule init

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ core philosophies:
2929
* input languages (blockly, javascript, coffeescript)
3030
* output modules (turtle graphics, javascript output, connected robots)
3131
* Flexible UI where elements can be easily added, modified or removed
32-
* Tutorial engine for self learning
32+
* Tutorial engine for self-learning
3333

3434
Licensing
3535
----------

doc/ADDON.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Coding with Chrome - Addon
22
===========================
33

4-
Adding additional addons
4+
Adding additional add-ons
55
-------------------------
66

77
### Create addon folder
@@ -10,10 +10,10 @@ For starting with an addon create a new folder under `src/addon/[Addon name]`.
1010

1111
### Addon rules
1212

13-
To make sure addons are user friendly and not disruptive, there are some
13+
To make sure addons are user-friendly and not disruptive, there are some
1414
general rules.
1515

16-
* The addon needs to be activated by the user an can not be auto-enabled.
16+
* The addon needs to be activated by the user and cannot be auto-enabled.
1717
* The addon should not change any core functionality.
1818

1919
### Events

doc/ARCHITECTURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ preparations to execute the user generated code.
101101

102102
### Runner
103103

104-
The runner is used if a hardware communication between the user generated code
104+
The runner is used if a hardware communication between the user-generated code
105105
and the serial, Bluetooth or USB interface is needed.
106106
The code will be executed in the sandbox as well, but will have limited access
107107
to the internal apis over the runner framekwork / runner api.

doc/BUILD_MAC_APP.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ using this document.
1212
Build the core files
1313
---------------------
1414

15-
In order to build the actual app you need first to build all core files.
15+
In order to build the actual app, you need first to build all core files.
1616
This step is normally needed only once and after an update of the core files.
1717
This could be done with the following command:
1818

@@ -40,7 +40,7 @@ npm run publish:nw_app-mac
4040
```
4141

4242
The build version will be compiled in the `/dist/binary/osx64` directory,
43-
together with all required packages and files.
43+
together with all the required packages and files.
4444

4545
### Launch the app
4646

doc/BUILD_RELEASE_CHECKLIST.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@ Coding with Chrome - Release checklist
44
<img src="../static_files/images/cwc_logo.png" align="right">
55

66
These following actions needs to be performed before each release.
7-
This makes sure that an release is not breaking any major function.
7+
This makes sure that a release is not breaking any major function.
88

99
Automated Tests
1010
----------------
1111

12-
Most of the general errors are catched by the automated tests.
12+
Most of the general errors are caught by the automated tests.
1313
But it's not possible to have an 100% test coverage, so these tests will not
1414
catch all race conditions.
1515

16-
- [ ] Run "npm run test" and check if any test fail
16+
- [ ] Run "npm run test" and check if any test fails
1717

1818
- [ ] Check <https://travis-ci.org/google/coding-with-chrome>
1919

2020
- [ ] Check <https://codeclimate.com/github/google/coding-with-chrome>
2121

2222
- [ ] Check coverage report under /coverage. The overall status should be
23-
at least 55%, if less additional tests needs to be added.
23+
at least 55%, if less additional tests need to be added.
2424

2525
UI Tests
2626
---------

doc/DEBUG.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Coding with Chrome - Debugging
22
===============================
33

4-
This document covers debugging informations and technique's for the
4+
This document covers debugging information and technique's for the
55
Coding with Chrome editor.
66

77
General options
@@ -33,7 +33,7 @@ npm run debug
3333

3434
### Sync latest files and dependencies
3535

36-
In some cases you need to update the dependencies to the latest version to
36+
In some cases, you need to update the dependencies to the latest version to
3737
get everything working. This can be done with the following command:
3838

3939
```bash
@@ -53,7 +53,7 @@ Live debugging
5353
---------------
5454

5555
The following methods will help you to debug certain functions or parts without
56-
the need to recompile the hole source code.
56+
the need to recompile the whole source code.
5757

5858
### Using dist/chrome_os/js/debug.js
5959

@@ -63,7 +63,7 @@ change function without the need of recompile everything.
6363
Just overwrite your function in the `dist/chrome_os/js/debug.js` file and reload
6464
the application to see your change in action.
6565

66-
In some cases it could be that you need to insert the hole object definition
66+
In some cases, it could be that you need to insert the whole object definition
6767
here and not only parts of it.
6868

6969
Original definition:
@@ -92,7 +92,7 @@ recompile the code.**
9292
Instead of overwriting definitions in the `dist/chrome_os/js/debug.js` file you
9393
could directly replace them in the `dist/chrome_os/js/cwc_ui.js` file.
9494

95-
Please keep in mind that this file contains optimized code, so its not really
95+
Please keep in mind that this file contains optimized code, so it's not really
9696
readable but this will also avoid to re-compile the code to test something.
9797

9898
Original `dist/chrome_os/js/cwc_ui.js`:

doc/DEVELOPMENT.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ You might also check Enable CSS Source Maps.
2121

2222
### Running the debug mode
2323

24-
During development you should only use the debug mode, which provides additional
25-
informations and pre-checks over:
24+
During development, you should only use the debug mode, which provides additional
25+
information and pre-checks over:
2626

2727
```bash
2828
npm run debug
@@ -34,7 +34,7 @@ Other options
3434
### Rebuild the app
3535

3636
If you change something in the source code, you need to re-compile it.
37-
After this you only need to reload the Chrome App to see your change in action.
37+
After this, you only need to reload the Chrome App to see your change in action.
3838

3939
### Update dependencies
4040

@@ -44,12 +44,12 @@ Run the following command to update the dependencies to the latest version:
4444
npm run sync
4545
```
4646

47-
After this you only need to reload the Chrome App to see your change in action.
47+
After this, you only need to reload the Chrome App to see your change in action.
4848

4949
### Google Drive support (experimental)
5050

5151
Since this feature is experimental, although problems are unlikely we can not
52-
guarantee this code is error free. Please make sure that you back up your
52+
guarantee this code is error-free. Please make sure that you back up your
5353
Google Drive data, or only use test accounts without critical files or data.
5454

5555
See: <https://developer.chrome.com/apps/app_identity>

doc/I18N.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Coding with Chrome - i18n translation
44
Adding additional language support
55
-----------------------------------
66

7-
### Create language folder
7+
### Create a language folder
88

99
If your language is currently not supported, create a new folder under
1010
`locales/[language code]/`.
@@ -75,9 +75,9 @@ the different type of text.
7575
(Skip the deprecated `locales/eng/translation.js` file!)
7676

7777
Please make sure that you only add translated text into this new file.
78-
It also fine to start with a few line and adding the rest later.
78+
It also fine to start with a few lines and adding the rest later.
7979

80-
If the new file is ready, create an pull request under the following URL:
80+
If the new file is ready, create a pull request under the following URL:
8181
<https://github.com/google/coding-with-chrome/pulls>
8282

8383
Translation Key Format
@@ -124,7 +124,7 @@ Missing translations
124124

125125
If you miss the translation for certain UI parts, please submit pull request to
126126
add them.
127-
All translations are using an KEY for the translation and maybe separates files
127+
All translations are using a KEY for the translation and maybe separates files
128128
like **locales/deu/welcome_screen.js**.
129129

130130
### In JavaScript files

doc/MODES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Workflow
1414
for the file type (cwc.file.Type).
1515

1616
3. The modder (cwc.mode.Modder) build the UI, loads the content and
17-
defines the used renderer according the mode config (cwc.mode.ConfigData).
17+
defines the used renderer according to the mode config (cwc.mode.ConfigData).
1818

1919
Add a new file_type
2020
--------------------

0 commit comments

Comments
 (0)