Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): added readme to electron folder, proofread main readme
- Loading branch information
1 parent
f06fbe0
commit 55919b7
Showing
3 changed files
with
35 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# ArcticViewer Desktop | ||
|
||
An electron wrapper for ArcticViewer. | ||
|
||
## Getting Started | ||
|
||
In this directory run | ||
|
||
```sh | ||
$ npm install # installs electron and other dependencies | ||
$ npm start # starts electron app | ||
``` | ||
|
||
You'll be presented a blank window prompting you to open a dataset. Use the hotkey _Ctrl/⌘ + O_ to open a dataset folder, File > Open... will present the same window to open a dataset. | ||
|
||
## Bundling | ||
|
||
Depending on your platform, you can bundle ArcticViewer as a native application with one of the following: | ||
|
||
```sh | ||
$ npm run build:mac # bundle for macOS | ||
$ npm run build:lin # bundle for Linux | ||
$ npm run build:win # bundle for Wondows | ||
``` | ||
|
||
The output from the build process will be placed in the folder `./bin/` |