Commit 0ed34ce6 authored by Joel Collins's avatar Joel Collins
Browse files

Update README.md

parent f3519b0d
Loading
Loading
Loading
Loading
+27 −10
Original line number Diff line number Diff line
# OpenFlexure Connect 
[![pipeline status](https://gitlab.com/openflexure/openflexure-microscope-jsclient/badges/master/pipeline.svg?style=flat-square)](https://gitlab.com/openflexure/openflexure-microscope-jsclient/commits/master)

A user client for the OpenFlexure Microscope, written in Vue.js.
## Quickstart

## Install
A general user-guide on setting up your microscope can be found [**here on our website**](https://www.openflexure.org/projects/microscope/).
This includes basic installation instructions suitable for most users.

A general guide on setting up your microscope, including the required software, can be found [here on our website](https://www.openflexure.org/projects/microscope/).
# Developer guidelines

## Develop
* Clone the repo, and run `npm install`
* Scripts to build, and package Electron apps, are included in `package.json`
## Creating releases

* Update the applications internal version number
	* `npm version X.y.z` (replace X.y.z with a semantic version number)
	* or `npm version {patch/minor/major}` (see https://docs.npmjs.com/cli/v6/commands/npm-version)
	* Git commit and git push
* Create a new version tag on GitLab (e.g. V1.2.0)
	* Make sure you prefix a lower case 'v', otherwise it won't be recognised as a release!
	* This will trigger a CI pipeline that builds the electron app, and deploys it
        * Note: This also updates the build servers nginx redirect map file

### Testing builds

## Builds and deployment
* Binaries will be built for testing on merge requests, and manual CI triggers
    * These builds expire after a week, and are intended for testing only.

* Binaries will be built **and deployed** on release tags.
    * These binaries will expire on GitLab after a week, but will be permanantly
    deployed to http://build.openflexure.org/openflexure-ev

## Local installation

* Clone the repo, and run `npm install`

Scripts to build, and package Electron apps, are included in `package.json`

### Build for your local operating system

* `npm run electron:build`

## Developer notes

### VS Code and ESLint
@@ -48,7 +65,7 @@ To prevent the editor from interfering with ESLint, add to your project `setting
}
```

### Changelogs
### Generate changelogs

* `npm install -g conventional-changelog-cli`
* `conventional-changelog -r 0 --config ./changelog.config.js -i CHANGELOG.md -s`
 No newline at end of file