Commit 13a4235e authored by Joel Collins's avatar Joel Collins
Browse files

Updated readme

parent f51b349a
Loading
Loading
Loading
Loading
+8 −35
Original line number Diff line number Diff line
# OpenFlexure.vue
A user client for the OpenFlexure Microscope, written in Vue.js.

## 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~~
## Install

* 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~~
* Installers for Linux, Raspberry Pi, Windows and MacOS will be released soon.

* ~~Capture~~
    * ~~UI elements for capture options~~
    * ~~Big, friendly capture button~~
    * ~~Metadata for captures~~
    * ~~Tags for captures~~
## Develop
* Clone the repo, and run `npm install`
* Scripts to build, and package Electron apps, are included in `package.json`

* Plugins
    * ~~Placeholder for other plugins~~
    * Accordion for:
        * ~~Autofocus~~ (Needs functionality added to placeholders)
        * ~~Recalibrate~~
## To-do

* Settings
  * Metadata keys to automatically add (e.g. userID, patientID)
 No newline at end of file