nervmag/README.rst

703 B

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> </head>

NervMag

A web video magnifier using webcam.

Install

Deploy on webserver

You need to install yarn to continue.

Go to the project directory and use following commands.

yarn install
yarn build

Just serve the dist directory with your web server.

Deploy on native platform with electron

TODO

Development

  • Fork the project or create a personal branch.

  • Do your stuff.

  • Create unit and e2e tests if possible.

  • Launch test.

yarn test:unit
yarn test:e2e
  • Ask for a merge request on master branch.

</html>