Skip to content

Commit

Permalink
Fixed .md files to be compatible with markdown linter.
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkusBordihn committed May 5, 2018
1 parent e350aaf commit 6d188b7
Show file tree
Hide file tree
Showing 24 changed files with 780 additions and 388 deletions.
5 changes: 5 additions & 0 deletions .markdownlintrc
@@ -0,0 +1,5 @@
{
"default": true,
"MD003": { "style": "setext_with_atx" },
"MD033": { "allowed_elements": ["img"] }
}
57 changes: 42 additions & 15 deletions BUILD.md
@@ -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)
37 changes: 26 additions & 11 deletions CONTRIBUTING.md
@@ -1,7 +1,12 @@
Contributing
=============

Want to contribute? Great! First, read this page (including the small print at
the end).

### Before you contribute
Before you contribute
----------------------

Before we can use your code, you must sign the
[Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
(CLA), which you can do online. The CLA is necessary mainly because you own the
Expand All @@ -16,40 +21,50 @@ us first through the issue tracker with your idea so that we can help out and
possibly guide you. Coordinating up front makes it much easier to avoid
frustration later on.

### General Workflow
General Workflow
-------------------

### 1. Fork the Repo

#### 1. Fork the Repo
You will find more details on [Fork a Repo](https://help.github.com/articles/fork-a-repo/)

#### 2. If needed, sync/rebase the branch to the master branch
### 2. If needed, sync/rebase the branch to the master branch

If the branch is even or ahead of master, you can skip this part.

In the case the branch is behind master, please sync/rebase the branch with the
master branch.

#### 3. Add your changes
### 3. Add your changes

Add your contribution and make sure to use as less needed commits or to squash
smaller commits.

#### 4. Test your changes
Please make sure your changes are working as expect and add additional unit or general tests to the test directory if needed.
### 4. Test your changes

Please make sure your changes are working as expect and add additional unit or
general tests to the test directory if needed.

### 5. Create a pull request for the forked branch

#### 5. Create a pull request for the forked branch
If everything works as expect, create a pull request for your forked branch.
See: [Creating a pull request](https://help.github.com/articles/creating-a-pull-request/)

#### 6. Merging into master branch
### 6. Merging into master branch

This step is handled by the "Coding with Chrome" team.
Depending on the change it could take up to 1 week before your change is merged
into the master branch and part of the bundled application.

Code reviews
-------------

### Code reviews
All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose.

The small print
----------------

### The small print
Contributions made by corporations are covered by a different agreement than
the one above, the
[Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).
2 changes: 2 additions & 0 deletions LICENSE.md
@@ -1,3 +1,5 @@
License
=======

Apache License
Version 2.0, January 2004
Expand Down

0 comments on commit 6d188b7

Please sign in to comment.