Updated readme

This commit is contained in:
Joel Collins 2019-02-28 09:37:45 +00:00
parent f51b349ae9
commit 13a4235e5a

View file

@ -1,42 +1,15 @@
# OpenFlexure.vue
A user client for the OpenFlexure Microscope, written in Vue.js.
## Install
* Installers for Linux, Raspberry Pi, Windows and MacOS will be released soon.
## Develop
* Clone the repo, and run `npm install`
* Scripts to build, and package Electron apps, are included in `package.json`
## To-do
* ~~Connect~~
* ~~Connect to user-input IP~~
* ~~Store connection in vuex store~~
* ~~Move~~
* ~~Read absolute position~~
* ~~Change absolute position~~
* ~~Keyboard movement~~
* ~~Mouse scroll focus~~
* ~~Double-click to centre~~
* Gallery
* ~~Basic card for each capture~~
* ~~Thumbnails~~
* ~~Reload button~~
* ~~Download buttons~~
* ~~Lightbox~~
* ~~Save to disk~~ (Redundant by context menu)
* ~~Basic info/metadata modal~~
* ~~Tags~~
* ~~Read tag list~~
* ~~Add tag button~~
* ~~Delete tag button~~
* ~~Tag filter~~
* ~~Capture~~
* ~~UI elements for capture options~~
* ~~Big, friendly capture button~~
* ~~Metadata for captures~~
* ~~Tags for captures~~
* Plugins
* ~~Placeholder for other plugins~~
* Accordion for:
* ~~Autofocus~~ (Needs functionality added to placeholders)
* ~~Recalibrate~~
* Settings
* Metadata keys to automatically add (e.g. userID, patientID)
* Metadata keys to automatically add (e.g. userID, patientID)