diff --git a/README.md b/README.md index 42bd006b..e6584f9b 100644 --- a/README.md +++ b/README.md @@ -26,51 +26,7 @@ Back | Cmd/Ctrl [ Forward | Cmd/Ctrl ] # Development - -## Prerequisites -* node >= v6.3.1 -> Use [nvm](https://github.com/creationix/nvm) to install the current stable version of node - -* python (v2.7.x recommended) -* If you're on Debian or Ubuntu, you'll need to install following packages: -```sh -$ sudo apt-get install build-essential libxext-dev libxtst-dev libxkbfile-dev -``` -## Installation - -Clone the source locally: - -```sh -$ git clone https://github.com/zulip/zulip-electron -$ cd zulip-electron -``` - -Install project dependencies: - -```sh -$ npm install -``` -Start the app: - -```sh -$ npm start -``` - -Start and watch changes - -```sh -$ npm run dev -``` -### Making a release - -To package app into an installer use command: -``` -npm run dist -``` -It will start the packaging process for operating system you are running this command on. Ready for distribution file (e.g. dmg, windows installer, deb package) will be outputted to `dist` directory. - -You can create Windows installer only when running on Windows, the same is true for Linux and OSX. So to generate all three installers you need all three operating systems. - +Please see our [development guide](./development.md) to get started and run app locally. # Contribute diff --git a/development.md b/development.md new file mode 100644 index 00000000..0369d7b4 --- /dev/null +++ b/development.md @@ -0,0 +1,46 @@ +# Development + +## Prerequisites +* node >= v6.3.1 +> Use [nvm](https://github.com/creationix/nvm) to install the current stable version of node + +* python (v2.7.x recommended) +* If you're on Debian or Ubuntu, you'll need to install following packages: +```sh +$ sudo apt-get install build-essential libxext-dev libxtst-dev libxkbfile-dev +``` +## Installation + +Clone the source locally: + +```sh +$ git clone https://github.com/zulip/zulip-electron +$ cd zulip-electron +``` + +Install project dependencies: + +```sh +$ npm install +``` +Start the app: + +```sh +$ npm start +``` + +Start and watch changes + +```sh +$ npm run dev +``` +### Making a release + +To package app into an installer use command: +``` +npm run dist +``` +It will start the packaging process for operating system you are running this command on. Ready for distribution file (e.g. dmg, windows installer, deb package) will be outputted to `dist` directory. + +You can create Windows installer only when running on Windows, the same is true for Linux and OSX. So to generate all three installers you need all three operating systems. +