README.md 1.69 KB
Newer Older
Thomas Marrinan's avatar
Thomas Marrinan committed
1
SAGE2
tmarrinan's avatar
tmarrinan committed
2 3 4
=======

Browser based implementation of SAGE. A cluster-based html viewer used for displaying elements across multiple browser windows.
tmarrinan's avatar
tmarrinan committed
5

tmarrinan's avatar
tmarrinan committed
6
### Requirements ###
Thomas Marrinan's avatar
Thomas Marrinan committed
7
* node.js
tmarrinan's avatar
tmarrinan committed
8 9
* ffmpeg
* poppler
tmarrinan's avatar
tmarrinan committed
10
* graphicsmagick
tmarrinan's avatar
tmarrinan committed
11

tmarrinan's avatar
tmarrinan committed
12
##### For Windows: #####
tmarrinan's avatar
tmarrinan committed
13

tmarrinan's avatar
tmarrinan committed
14
* Download and install [Node.js](http://nodejs.org/)
tmarrinan's avatar
tmarrinan committed
15 16 17
* Download and install [7-Zip](http://www.7-zip.org/)
* Download [FFMpeg](http://ffmpeg.zeranoe.com/builds/)
* Download [Poppler-utils](http://manifestwebdesign.com/2013/01/09/xpdf-and-poppler-utils-on-windows/)
tmarrinan's avatar
tmarrinan committed
18
* Download [GraphicsMagick (Q8)](ftp://ftp.graphicsmagick.org/pub/GraphicsMagick/windows/)
tmarrinan's avatar
tmarrinan committed
19 20 21 22 23 24 25 26 27 28 29

Install FFMpeg
* Move the FFMpeg 7-zip file to "C:\"
* Right-click, go to 7-Zip > Extract Here
* Rename extracted folder to "FFMpeg"

Install Poppler
* Create Folder "C:\Poppler"
* Move the Poppler-utils zip file to "C:\Poppler"
* Right-click, go to 7-Zip > Extract Here

tmarrinan's avatar
tmarrinan committed
30 31 32 33
Install GraphicsMagick
* Create Folder "C:\GraphicsMacgick"
* Move the GraphicsMagick Q8 executable to "C:\GraphicsMacgick"

tmarrinan's avatar
tmarrinan committed
34
Set Environment
tmarrinan's avatar
tmarrinan committed
35
* Add "C:\FFMpeg", "C:\Poppler" and "C:\GraphicsMacgick" to you PATH variable
tmarrinan's avatar
tmarrinan committed
36

tmarrinan's avatar
tmarrinan committed
37 38 39 40
###### Setup Node js: ######
Open 'keys/GO-windows.bat'
Add lines with list of hostnames for your server
```
Thomas Marrinan's avatar
Thomas Marrinan committed
41
cd <SAGE2_directory>
tmarrinan's avatar
tmarrinan committed
42
npm install
tmarrinan's avatar
tmarrinan committed
43
cd keys\
tmarrinan's avatar
tmarrinan committed
44 45
.\GO-windows.bat
```
tmarrinan's avatar
tmarrinan committed
46

tmarrinan's avatar
tmarrinan committed
47
##### For Mac OSX: #####
tmarrinan's avatar
tmarrinan committed
48

tmarrinan's avatar
tmarrinan committed
49 50
* Download and install [Node.js](http://nodejs.org/)
* Download and install [homebrew](http://brew.sh/)
tmarrinan's avatar
tmarrinan committed
51 52
```
brew install ffmpeg 
tmarrinan's avatar
tmarrinan committed
53 54
brew install poppler --without-glib
brew install graphicsmagick
tmarrinan's avatar
tmarrinan committed
55 56
```

tmarrinan's avatar
tmarrinan committed
57 58
###### Setup Node js: ######
Open 'keys/GO-mac'
tmarrinan's avatar
tmarrinan committed
59
Edit ```servers``` to be a list of hostnames for your server
tmarrinan's avatar
tmarrinan committed
60
```
Thomas Marrinan's avatar
Thomas Marrinan committed
61
cd <SAGE2_directory>
tmarrinan's avatar
tmarrinan committed
62
npm install
tmarrinan's avatar
tmarrinan committed
63
cd keys/
tmarrinan's avatar
tmarrinan committed
64
./GO-mac
tmarrinan's avatar
tmarrinan committed
65
```
tmarrinan's avatar
tmarrinan committed
66 67 68

=======

Thomas Marrinan's avatar
Thomas Marrinan committed
69
##### Run SAGE2: #####
tmarrinan's avatar
tmarrinan committed
70
```
Thomas Marrinan's avatar
Thomas Marrinan committed
71
cd <SAGE2_directory>
tmarrinan's avatar
tmarrinan committed
72 73
node server.js
```