jeans/etcher
jeans/etcher
1
0
Fork 0
mirror of https://github.com/balena-io/etcher.git synced 2025-07-23 11:16:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move README "Developing" section to CONTRIBUTING.md (#380)

Browse Source 
Signed-off-by: Juan Cruz Viotti <jviottidc@gmail.com>
This commit is contained in:
Juan Cruz Viotti 2016-04-29 09:03:15 -04:00
parent bd410bd88c
commit d373d32472
2 changed files with 23 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
CONTRIBUTING.md
View File

@ -8,18 +8,34 @@ Thanks for your interest in contributing to this project! This document aims to
- [Bower](http://bower.io).
- [Gulp](http://gulpjs.com).
## Cloning
## Running locally
First, clone the repository:
You can manually run the application with the following steps:
``` shell
$ git clone https://github/resin-io/etcher
- Clone the repository.
```sh
git clone https://github.com/resin-io/etcher
cd etcher
```
Make sure you install all the dependencies before attempting to run the application:
- Install dependencies.
``` shell
$ npm install && bower install
```sh
npm install
bower install
```
- Run the GUI application.
```sh
npm start
```
- Run the CLI application.
```sh
node bin/etcher
```
## Developing
@ -40,14 +56,6 @@ $ gulp watch
We make use of [EditorConfig](http://editorconfig.org) to communicate indentation, line endings and other text editing default. We encourage you to install the relevant plugin in your text editor of choice to avoid having to fix any issues during the review process.
## Running
You can run the application with the following command in the root of the project:
``` shell
$ npm start
```
## Testing
We include a test suite that covers both the code running in the main process and in the rendered process.

33
README.md
View File

@ -22,39 +22,6 @@ Installers
Refer to the [downloads page](http://etcher.io) for the latest pre-made installers for all supported operating systems.
Developing
----------
You can manually run the application with the following steps:
- Clone the repository.
```sh
git clone https://github.com/resin-io/etcher
cd etcher
```
- Install dependencies.
```sh
npm install
bower install
```
- Run the GUI application.
```sh
npm start
```
- Run the CLI application.
```sh
node bin/etcher
```
Take a look at our [contributing guide](https://github.com/resin-io/etcher/blob/master/CONTRIBUTING.md).
Support
-------