doc: extract development setup docs into RUNNING-LOCALLY.md (#667)

This file will contain all information necessary to be able to get a
development version of Etcher running locally.

Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>
This commit is contained in:
Juan Cruz Viotti 2016-08-26 15:48:17 -04:00 committed by GitHub
parent 47c50ffe14
commit a4e3359a96
3 changed files with 81 additions and 90 deletions

View File

@ -10,69 +10,10 @@ High-level Etcher overview
Make sure you checkout our [ARCHITECTURE.md][ARCHITECTURE] guide, which aims to
explain how all the pieces fit together.
Prerequisites
-------------
- [NodeJS](https://nodejs.org).
- [Bower](http://bower.io).
- [UPX](http://upx.sourceforge.net).
- [Python](https://www.python.org).
- [SCSS Lint](https://github.com/brigade/scss-lint/).
### Windows
- [rimraf](https://github.com/isaacs/rimraf).
- [asar](https://github.com/electron/asar).
- [NSIS](http://nsis.sourceforge.net/Main_Page).
Running locally
---------------
- Install [NodeJS](https://nodejs.org/en/).
- Clone the repository.
```sh
git clone https://github.com/resin-io/etcher
cd etcher
```
- Install dependencies.
Please make use of the following scripts to install dependencies rather than
simply running `npm install` given that we need to do extra configuration to
make sure native dependencies are correctly compiled for Electron, otherwise
the application might not run successfully.
- OS X
```sh
./scripts/build/darwin.sh install
```
- GNU/Linux
```sh
./scripts/build/linux.sh install <x64|x86>
```
- Windows
```sh
.\scripts\build\windows.bat install <x64|x86>
```
- Run the GUI application.
```sh
npm start
```
- Run the CLI application.
```sh
node bin/etcher
```
See the [RUNNING-LOCALLY.md][RUNNING-LOCALLY] guide.
Developing
----------
@ -175,6 +116,7 @@ systems we support.
Don't hesitate to get in touch if you have any questions or need any help!
[ARCHITECTURE]: https://github.com/resin-io/etcher/blob/master/docs/ARCHITECTURE.md
[RUNNING-LOCALLY]: https://github.com/resin-io/etcher/blob/master/docs/RUNNING-LOCALLY.md
[EditorConfig]: http://editorconfig.org
[commitizen]: https://commitizen.github.io/cz-cli/#making-your-repo-commitizen-friendly
[shrinkwrap]: https://docs.npmjs.com/cli/shrinkwrap

View File

@ -4,14 +4,6 @@ Publishing Etcher
This is a small guide to package and publish Etcher to all supported operating
systems.
Common Pre-requisites
---------------------
- [NodeJS](https://nodejs.org)
- [Bower](http://bower.io)
- [UPX](http://upx.sourceforge.net)
- [Python](https://www.python.org)
Signing
-------
@ -39,28 +31,6 @@ Packaging
The resulting installers will be saved to `etcher-release/installers`.
### Windows
Pre-requisites:
- [NSIS](http://nsis.sourceforge.net/Main_Page)
- [Visual Studio Community 2013](https://www.visualstudio.com/en-us/news/vs2013-community-vs.aspx)
- [Rimraf](https://github.com/isaacs/rimraf)
- [asar](https://github.com/electron/asar)
Run the following command from the *Developer Command Prompt for VS2013*, to
ensure all Visual Studio command utilities are available in the `%PATH%`:
```sh
> .\scripts\build\windows.bat all <x64|x86>
```
### OS X
Pre-requisites:
- [XCode](https://developer.apple.com/xcode://developer.apple.com/xcode/)
Run the following command:
```sh

79
docs/RUNNING-LOCALLY.md Normal file
View File

@ -0,0 +1,79 @@
Running locally
===============
This document aims to serve as a guide to get Etcher running locally on your
development machine.
Prerequisites
-------------
### Common
- [NodeJS](https://nodejs.org)
- [Bower](http://bower.io)
- [UPX](http://upx.sourceforge.net)
- [Python](https://www.python.org)
- [SCSS Lint](https://github.com/brigade/scss-lint/)
### Windows
- [Rimraf](https://github.com/isaacs/rimraf)
- [Asar](https://github.com/electron/asar)
- [NSIS](http://nsis.sourceforge.net/Main_Page)
- [Visual Studio Community 2013](https://www.visualstudio.com/en-us/news/vs2013-community-vs.aspx)
### OS X
- [XCode](https://developer.apple.com/xcode/)
Cloning the project
-------------------
```sh
git clone https://github.com/resin-io/etcher
cd etcher
```
Installing dependencies
-----------------------
Please make use of the following scripts to install dependencies rather than
simply running `npm install` given that we need to do extra configuration to
make sure native dependencies are correctly compiled for Electron, otherwise
the application might not run successfully.
### OS X
```sh
./scripts/build/darwin.sh install
```
### GNU/Linux
```sh
./scripts/build/linux.sh install <x64|x86>
```
### Windows
**Run the following command from the _Developer Command Prompt for VS2013_**,
to ensure all Visual Studio command utilities are available in the `%PATH%`:
```sh
.\scripts\build\windows.bat install <x64|x86>
```
Running the application
-----------------------
### GUI
```sh
npm start
```
### CLI
```sh
node bin/etcher
```