Skip to content

Commit

Permalink
docs(readme): added readme to electron folder, proofread main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TristanWright committed Oct 21, 2016
1 parent f06fbe0 commit 55919b7
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 9 deletions.
16 changes: 8 additions & 8 deletions README.md
Expand Up @@ -49,9 +49,9 @@ $ ArcticViewer
In order to try it out, you should download some sample datasets
(unless you already have some ;-) and run the data viewer on them.

Here is an example on how to download some sample data
Here is an example on how to download some sample data:

```
```sh
$ mkdir sample-data && cd $_
$ ArcticViewer --download-sample-data

Expand All @@ -71,7 +71,7 @@ $ ArcticViewer --download-sample-data
| Press Enter to quit or the dataset number to download: 8
| Press Enter to quit or the dataset number to download:
|
| => You will be able to try ArcticViewer with those commands:
| => You will be able to try ArcticViewer with these commands:
|
| $ ArcticViewer -d /tmp/head_ct_4_features
| $ ArcticViewer -d /tmp/diskout-composite
Expand All @@ -81,27 +81,27 @@ $ ArcticViewer --download-sample-data

```

Then you can load them using the provided feedback or by running the following
Then you can view them using the provided feedback or by running the following
command lines:

```
```sh
$ ArcticViewer -d ./sample-data/mpas-probe-flat-earth
```

This will load a MPAS oceanic simulation data that represent a 3D volume of a
flatten version of the earth with Temperature and Salinity information on the water.
flattened version of the Earth with temperature and salinity information on the oceans.

From that data you can look at a slice of the data along any axis and move the
slice back and forth using the scroll of your input device.

If you want to zoom or pan, you will have to scroll+[any modifier key] or drag+[any modifier key].

```
```sh
$ ArcticViewer -d ./sample-data/hydra-image-fluid-velocity
```

This will load an Hydra CFD simulation data that represent the fluid velocity
using some volume rendering technique.
using some volume rendering techniques.

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion bin/arctic-data-downloader.js
Expand Up @@ -212,7 +212,7 @@ function downloadAvailableDatasets(list) {
var downloadCount = 0,
doneCount = 0;

console.log(" |\n | => You will be able to try ArcticViewer with those commands:\n |");
console.log(" |\n | => You will be able to try ArcticViewer with these commands:\n |");

function done() {
doneCount++;
Expand Down
26 changes: 26 additions & 0 deletions electron/README.md
@@ -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/`

0 comments on commit 55919b7

Please sign in to comment.