Skip to content
This repository
Browse code

Update README.md

  • Loading branch information...
commit ee8e88ce7cb0c1fd43ee9917f0e15bdf657f192b 1 parent 4168aaf
Dane Springmeyer authored December 13, 2012

Showing 1 changed file with 25 additions and 43 deletions. Show diff stats Hide diff stats

  1. 68  README.md
68  README.md
Source Rendered
@@ -30,8 +30,7 @@ Requirements
30 30
   - May work: Opera 11
31 31
 - *TileStream server*
32 32
   - Tested: Mac OS X 10.6, Ubuntu 10.04, Ubuntu 11.04
33  
-  - Tested: node 0.4.9
34  
-  - Tested: npm v1.0.3
  33
+  - Tested: node 0.8.x
35 34
   - At least 613MB memory
36 35
   - May work: Older versions, other POSIX-compliant systems
37 36
 
@@ -42,36 +41,25 @@ Install [Xcode][3] for Mac OS X.
42 41
 
43 42
 Install [node][4]. If you are using [HomeBrew][12], use these steps:
44 43
 
45  
-    brew install node       # Installs the latest node, perhaps 0.6.x
  44
+    brew install node       # Installs the latest node: should be v0.8.x
46 45
     brew versions node      # Find all the different versions of node available
47  
-    # We need node 0.4.9 for tilestream, so switch to that node version
48  
-    cd /usr/local/Cellar/node
49  
-    git checkout -b node-0.4.9 10b3ded # The commit that correspons in the versions output
50  
-    brew install node       # Now installiong 0.4.9
51  
-    brew switch node 0.4.9  # set current node version
  46
+    brew switch node 0.8.15  # set current node version
52 47
 
53  
-Install [npm][5]:
54  
-
55  
-    curl https://npmjs.org/install.sh | sh
56 48
 
57 49
 Install TileStream:
58 50
 
59  
-If you have a checked out copy of the source, build it:
60  
-
  51
+    git clone git@github.com:mapbox/tilestream.git
  52
+    cd tilestream
61 53
     npm install
62 54
 
63  
-You may also install from anywhere:
64  
-
65  
-    npm install -g tilestream
66  
-
67  
-This will install TileStream globally. If you want a local installation in
68  
-your current working directory, run the command without the `-g` option.
69  
-
70 55
 Start TileStream:
71 56
 
72  
-    tilestream (if you installed globally)
73 57
     ./index.js (if running from the source copy)
74 58
 
  59
+Get options:
  60
+
  61
+    ./index.js start --help
  62
+
75 63
 TileStream should now be accessible from a browser at `http://localhost:8888`.
76 64
 
77 65
 
@@ -83,37 +71,31 @@ Install build requirements:
83 71
 
84 72
 Install node:
85 73
 
86  
-    git clone --depth 1 git://github.com/joyent/node.git
87  
-    cd node
88  
-    git checkout v0.4.9
89  
-    export JOBS=2 # optional, sets number of parallel commands.
90  
-    mkdir ~/local
91  
-    ./configure --prefix=$HOME/local/node
92  
-    make
93  
-    make install
94  
-    echo 'export PATH=$HOME/local/node/bin:$PATH' >> ~/.profile
95  
-    source ~/.profile
  74
+    sudo apt-add-repository ppa:chris-lea/node.js
  75
+    sudo apt-get update
  76
+    sudo apt-get install nodejs nodejs-dev npm
  77
+
  78
+Install TileStream:
96 79
 
97  
-Install [npm][5]:
  80
+    git clone git@github.com:mapbox/tilestream.git
  81
+    cd tilestream
  82
+    npm install
98 83
 
99  
-    curl http://npmjs.org/install.sh | sh
  84
+Start TileStream:
100 85
 
101  
-Install TileStream:
  86
+    ./index.js (if running from the source copy)
102 87
 
103  
-    npm install -g tilestream
  88
+Get options:
104 89
 
105  
-This will install TileStream globally. If you want a local installation in
106  
-your current working directory, run the command without the `-g` option.
  90
+    ./index.js start --help
107 91
 
108  
-Start TileStream:
109 92
 
110  
-    tilestream
  93
+Custom configuration
  94
+--------------------
111 95
 
112  
-TileStream should now be accessible from a browser at `http://localhost:8888`.
113 96
 If you intend to run TileStream as a server on a hostname or an IP rather than
114 97
 as localhost, specify that hostname when you run TileStream:
115 98
 
116  
-
117 99
     tilestream --host 127.0.0.1
118 100
     tilestream --host yourhost.com
119 101
 
@@ -144,15 +126,15 @@ Tileset filenames:
144 126
 
145 127
 To see the options available for use with TileStream, run
146 128
 
147  
-    tilestream start --help
  129
+    ./index.js start --help
148 130
 
149 131
 
150 132
 Tests
151 133
 -----
152 134
 TileStream tests use [Expresso][6].
153 135
 
154  
-    npm install -g expresso
155 136
     cd tilestream
  137
+    npm install expresso
156 138
     npm test
157 139
 
158 140
 

0 notes on commit ee8e88c

Please sign in to comment.
Something went wrong with that request. Please try again.