Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixed .md files to be compatible with markdown linter.
- Loading branch information
1 parent
e350aaf
commit 6d188b7
Showing
24 changed files
with
780 additions
and
388 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"default": true, | ||
"MD003": { "style": "setext_with_atx" }, | ||
"MD033": { "allowed_elements": ["img"] } | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,72 +1,99 @@ | ||
Build Coding with Chrome | ||
========================= | ||
<p align="center"><img src="static_files/images/cwc_logo.png"></p> | ||
|
||
## What you need to build your own Coding with Chrome App | ||
In order to build the Coding with Chrome App, you only need to have Node.js/npm, git and Open JDK / Java JRE installed on your system. | ||
<img src="static_files/images/cwc_logo.png" align="left"> | ||
|
||
What you need to build the Coding with Chrome App | ||
-------------------------------------------------- | ||
|
||
In order to build the Coding with Chrome App, you only need to have Node.js/npm, | ||
git and Open JDK / Java JRE installed on your system. | ||
|
||
Each build is cross platform compatible. Which mean if you build the | ||
Coding with Chrome App on Windows you could use the generated code | ||
`genfiles/chrome_app` folder in other platforms like Mac OS X as well. | ||
|
||
### Windows | ||
Install Node.js from the official web page at https://nodejs.org | ||
|
||
Install Node.js from the official web page at <https://nodejs.org> | ||
|
||
* Optional, if not already installed | ||
* Install git from the official web page at https://git-scm.com/ | ||
* Install git from the official web page at <https://git-scm.com/> | ||
* Install Java JRE | ||
* Install Google Chrome browser at https://google.com/chrome | ||
* Install Google Chrome browser at <https://google.com/chrome> | ||
|
||
### Mac OS X | ||
Install Node.js from the official web page at https://nodejs.org | ||
|
||
Install Node.js from the official web page at <https://nodejs.org> | ||
|
||
* Optional, if not already installed | ||
* Install git from the official web page at https://git-scm.com/ | ||
* Install git from the official web page at <https://git-scm.com/> | ||
* Install Java JRE | ||
* Install Google Chrome browser at https://google.com/chrome | ||
* Install Google Chrome browser at <https://google.com/chrome> | ||
|
||
### Linux/BSD | ||
|
||
Use your package manager to install Node.js, or build from source. | ||
|
||
* Optional, if not already installed | ||
* Use your package manager to install git, or build from source. | ||
* Install Open JDK or Java JRE | ||
* Install Google Chrome browser at https://google.com/chrome | ||
* Install Google Chrome browser at <https://google.com/chrome> | ||
|
||
## How to build your own Coding with Chrome App | ||
How to build your own Coding with Chrome App | ||
--------------------------------------------- | ||
|
||
### Get the sources | ||
|
||
Download the source files manual from GitHub or with git by running: | ||
|
||
```bash | ||
git clone --recursive git://github.com/google/coding-with-chrome.git | ||
``` | ||
|
||
### Switch into the downloaded folder | ||
To be able to execute the following commands, you need to switch to the downloaded folder by running: | ||
|
||
To be able to execute the following commands, you need to switch to the | ||
downloaded folder by running: | ||
|
||
```bash | ||
cd coding-with-chrome | ||
``` | ||
|
||
### Init / update submodules | ||
|
||
In some cases you need to init and update the submodules manually by: | ||
|
||
```bash | ||
git submodule init | ||
git submodule update | ||
``` | ||
|
||
### Get required packages | ||
|
||
Enter the "coding-with-chrome" directory and get the required packages by: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
### Sync the project folder | ||
In order to update all dependencies automatically, just run the following command: | ||
|
||
In order to update all dependencies automatically, just run the following | ||
command: | ||
|
||
```bash | ||
npm run sync | ||
``` | ||
|
||
### Build the actual app | ||
There are several ways to use Coding with Chrome, each of them have their advantage or disadvantage. | ||
|
||
There are several ways to use Coding with Chrome, each of them have their | ||
advantage or disadvantage. | ||
|
||
In general we are offering the following versions: | ||
|
||
* [Chrome Application (Chrome OS)](doc/BUILD_CHROME_OS.md) | ||
* Binary ([Mac](doc/BUILD_MAC_APP.md), [Windows](doc/BUILD_WIN_APP.md) and [Linux](doc/BUILD_LINUX_APP.md)) | ||
* Binary ([Mac](doc/BUILD_MAC_APP.md), | ||
[Windows](doc/BUILD_WIN_APP.md) and [Linux](doc/BUILD_LINUX_APP.md)) | ||
* [Web (any modern Browser / experimental)](doc/BUILD_WEB.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
License | ||
======= | ||
|
||
Apache License | ||
Version 2.0, January 2004 | ||
|
Oops, something went wrong.