Create README.MD

This commit is contained in:
TheGreyDiamond
2022-01-02 18:40:43 +01:00
parent 0282857cc0
commit 7287a8bb83

10
README.MD Normal file
View File

@ -0,0 +1,10 @@
# open360viewer
open360viewer is an opensource 360° image viewer. It is based on electron and marzipano. It currently supports opening equirectangular 360° images.
## Getting started
Currently the viewer can only be used if you have nodeJs installed. Complete packaging is planned.
1. Install dependencies using `npm install`
2. Build and minify all assets using `npm run buildCss` and `npm run minify`
3. Just run it using `npm start`
If you are developing you might want to use `npm run startDev` as it also builds all assets at each launch.