1.6.0 2

README.md

@@ -1,18 +1,17 @@
+# Digital Paper Edit - Electron
 
-#  Digital Paper Edit - Electron 
 Electron Cross Platform Desktop app
 
 ---> _Work in progress_ <--
 
 For a ready to use release of the desktop application, checkout the [user manual](https://autoedit.gitbook.io/digital-paper-edit-user-manual/installing) for more details on how to get started.
 
-
 [See here for overall project architecture info](https://github.com/bbc/digital-paper-edit-client#project-architecture)
 
-
 [Github project board (for my forks) - across linked repos](https://github.com/users/pietrop/projects/1)
 
 ## Setup
+
 <!-- _stack - optional_
 _How to build and run the code/app_ -->
 
@@ -25,11 +24,13 @@ cd digital-paper-edit-electron
 ```
 
 Optional step to setup [nvm](https://github.com/nvm-sh/nvm) to use node version 10, otherwise just use node version 10
+
 ```
 nvm use || nvm install`
 ```
 
 in root of project
+
 ```
 npm install
 ```
@@ -39,14 +40,15 @@ npm install
 ```
 npm start
 ```
-
 
 ## System Architecture
+
 <!-- _High level overview of system architecture_ -->
 
- Electron Cross platform desktop app
+Electron Cross platform desktop app
 
 ## Development env
+
  <!-- _How to run the development environment_
 
 _Coding style convention ref optional, eg which linter to use_
@@ -60,10 +62,11 @@ _Linting, github pre-push hook - optional_ -->
 Node version is set in node version manager [`.nvmrc`](https://github.com/creationix/nvm#nvmrc)
 
 ## Build
+
 <!-- _How to run build_ -->
 
-<!-- 
-TODO: needs to pull in React front end from npm. 
+<!--
+TODO: needs to pull in React front end from npm.
 eg how it was done in Makefile before
 
 build-electron: build-react
@@ -77,7 +80,7 @@ build-electron: build-react
 	# build/package electron for mac, wind and linux
 	cd ./packages/electron && npm run build:mwl
 
-and then run 
+and then run
 
 ```
 npm run build:mwl
@@ -88,32 +91,42 @@ _TBC_
 
 ## Tests
 
- _TBC_
+_TBC_
 
 ## Deployment
+
 <!-- _How to deploy the code/app into test/staging/production_ -->
 
 We use [Travis CI](https://travis-ci.org/pietrop/digital-paper-edit-electron/builds/) to build. And add new versions to [github releases](https://github.com/pietrop/digital-paper-edit-electron/releases).
+
 <!-- Probably through Travis or Circle CI -->
 
 However if you want to run a build and package the app locally you can use the npm scripts
 
 To build for mac, windows, and linux
+
 ```
 npm run build:mwl
 ```
+
 To build for mac only
+
 ```
 npm run build:m
 ```
+
 To build for windows only
+
 ```
 npm run build:w
 ```
+
 To build for linux only
+
 ```
 npm run build:l
 ```
 
+The build, packaged app will be in the `/dist` folder.
 
-The build, packaged app will be in the `/dist` folder.
+<!-- 1.6.0 -->