➡️ global linking of 'mapscii'

This commit is contained in:
Michael Straßburger 2016-11-03 23:13:44 +01:00
parent 24434052cb
commit 4ba7c08755
3 changed files with 19 additions and 11 deletions

View File

@ -1,6 +1,6 @@
# termap - Terminal Map Viewer # MapSCII - Map Viewer for your console
No web browser around? No worries - discover the planet in your console! No web browser around? Don't worry - and discover the planet in your console!
<img src="http://i.imgur.com/yYVt7No.png" width="100%" /> <img src="http://i.imgur.com/yYVt7No.png" width="100%" />
@ -8,24 +8,23 @@ No web browser around? No worries - discover the planet in your console!
* Discover the globe or zoom in to explore your neighbourhood * Discover the globe or zoom in to explore your neighbourhood
* See Point-of-Interest around any given location * See Point-of-Interest around any given location
* Use an online map server or work offline with VectorTile/MBTiles * Use an online map server or work offline with VectorTile/MBTiles
* Highly customizable styling (colors, feature visibility, ...) * Highly customizable styling (reuse your [mapbox-gl-style](https://github.com/mapbox/mapbox-gl-styles)s)
* Compatible with Linux and OS X (Windows to be tested) * Compatible with Linux' and OS X' terminals, Windows support via [PuTTY](http://www.putty.org/)
* 99% pure Coffee-/JavaScript! :sunglasses: * 99% pure Coffee-/JavaScript! :sunglasses:
## How to get it? ## How to get it?
* Make sure to have at least [node.js](https://nodejs.org/) version 4 installed * Make sure to have at least [node.js](https://nodejs.org/) version 4 installed
* Install `termap` with * Open your terminal!
* Install `mapscii` with
`npm install -g termap` `npm install -g mapscii`
## How to use it? ## How to use it?
#### Basic usage #### Basic usage
* Start `termap` with * Start `mapscii` with
` termap` ` mapscii`
## Behind the scenes ## Behind the scenes
@ -63,7 +62,7 @@ No web browser around? No worries - discover the planet in your console!
* [ ] VectorTile * [ ] VectorTile
* [ ] MBTile * [ ] MBTile
* [ ] Tileserver * [ ] Tileserver
* [ ] termap-server * [ ] mapscii-server
* [ ] telnet * [ ] telnet
* [ ] ssh * [ ] ssh
* [ ] Viewport * [ ] Viewport

6
bin/mapscii.sh Executable file
View File

@ -0,0 +1,6 @@
#!/bin/sh
':' //; # Based on https://github.com/MrRio/vtop/blob/master/bin/vtop.js
':' //; export TERM=xterm-256color
':' //; exec "$(command -v nodejs || command -v node)" "$0" "$@"
'use strict'
require('../main.js');

View File

@ -11,6 +11,9 @@
"type": "git", "type": "git",
"url": "https://github.com/rastapasta/mapscii.git" "url": "https://github.com/rastapasta/mapscii.git"
}, },
"bin": {
"mapscii": "./bin/mapscii.sh"
},
"keywords": [ "keywords": [
"map", "map",
"console", "console",