[tor-commits] [globe/master] Cleaning up a lot of the readme spacing so the file is more legible.
isis at torproject.org
isis at torproject.org
Thu May 21 07:58:10 UTC 2015
commit 3398844dedd0cd4e5be9bb1af7405fc7bf1e1085
Author: Randall Degges <r at rdegges.com>
Date: Wed May 20 19:41:40 2015 -0700
Cleaning up a lot of the readme spacing so the file is more legible.
---
README.md | 90 +++++++++++++++++++++++++++++++++++++++++--------------------
1 file changed, 61 insertions(+), 29 deletions(-)
diff --git a/README.md b/README.md
index a69b9f3..4ec1263 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,29 @@
![Globe Logo][]
+[](https://travis-ci.org/makepanic/globe)
-JavaScript application to search and view details for Tor relays and bridges. All the data comes from the [Tor onionoo API](https://onionoo.torproject.org/). Uses [Ember.js](http://emberjs.com/) as JavaScript framework.
-Inspired by the official [Tor Atlas](https://atlas.torproject.org/).
-Tor Onionoo Search is not affiliated with the Tor project. "Tor" and the "Onion Logo" are registered trademarks of The Tor Project, Inc.
+JavaScript application to search and view details for Tor relays and bridges.
+All the data comes from the [Tor onionoo API](https://onionoo.torproject.org/).
+Uses [Ember.js](http://emberjs.com/) as JavaScript framework. Inspired by the
+official [Tor Atlas](https://atlas.torproject.org/).
-##Use the application [](https://travis-ci.org/makepanic/globe)
+Tor Onionoo Search is not affiliated with the Tor project. "Tor" and the "Onion
+Logo" are registered trademarks of The Tor Project, Inc.
-To use a hosted version of Globe, [click here to open http://globe.rndm.de](http://globe.rndm.de/).
-If you want to build your own version take a look at the [grunt targets](#grunt-targets) section.
-If you can't or don't want to build the application on your own, you could download the latest archived relase from [the release page](https://github.com/makepanic/globe/releases).
+## Use the application
-##Features
+To use a hosted version of Globe,
+[click here to open http://globe.rndm.de](http://globe.rndm.de/). If you want
+to build your own version take a look at the [grunt targets](#grunt-targets)
+section.
+
+If you can't or don't want to build the application on your own, you could
+download the latest archived relase from [the release page](https://github.com/makepanic/globe/releases).
+
+
+## Features
- search for bridges or relays
- advanced search with country, running, flags and other filters
@@ -21,9 +31,11 @@ If you can't or don't want to build the application on your own, you could downl
- interactive graphs using dygraphs
- shareable links for searches or details
-##License
-Globe is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
+## License
+
+Globe is open-sourced software licensed under the
+[MIT license](http://opensource.org/licenses/MIT)
Project | License
--- | ---
@@ -40,60 +52,80 @@ Project | License
[jquery deparam](https://github.com/chrissrogers/jquery-deparam/blob/master/jquery-deparam.js) | [MIT license](http://opensource.org/licenses/MIT) [@](http://benalman.com/about/license/)
[jsSHA](http://caligatio.github.io/jsSHA/) | [BSD license](https://github.com/Caligatio/jsSHA/blob/release-1.42/LICENSE)
-##Installation
-Globe is tested and build with nodejs (0.10.x). For an easy overview on how to install node on your distribution look at
+## Installation
+
+Globe is tested and build with nodejs (0.10.x). For an easy overview on how
+to install node on your distribution look at
[Installing Node.js via package manager](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager).
-In addition to that, globe can be built in a virtual machine that is managed using [Vagrant](http://www.vagrantup.com/).
-To make it easier for you, we provide a [Vagrantfile](https://gitweb.torproject.org/globe.git/blob/HEAD:/Vagrantfile) that builds an ubuntu (12.04) virtual machine
-with everything necessary for developing and building globe. If you have vagrant installed run `vagrant up` and wait until everything is ready.
+In addition to that, globe can be built in a virtual machine that is managed
+using [Vagrant](http://www.vagrantup.com/). To make it easier for you, we
+provide a [Vagrantfile](https://gitweb.torproject.org/globe.git/blob/HEAD:/Vagrantfile)
+that builds an ubuntu (12.04) virtual machine with everything necessary for
+developing and building globe. If you have vagrant installed run `vagrant up`
+and wait until everything is ready.
+
+Connect to your running virtual machine via `vagrant ssh`. Using the shared
+folder (`cd /vagrant/`) you can continue building globe using the following
+commands.
-Connect to your running virtual machine via `vagrant ssh`.
-Using the shared folder (`cd /vagrant/`) you can continue building globe using the following commands.
-###Summary:
+### Summary:
1. `npm install` (not necessary in the vagrant machine)
2. `grunt`
3. `node app.js`
-###Explanation
+
+### Explanation
1. First you need all the npm dependencies. Run `npm install`.
-2. Now you're ready to build the application and start the server. Call `grunt` and wait for it to complete the build process. Grunt precompiles the handlebars templates, combines all the different JavaScript and CSS files and minifies them. This can take a while depending on your computer.
+2. Now you're ready to build the application and start the server. Call
+ `grunt` and wait for it to complete the build process. Grunt precompiles
+ the handlebars templates, combines all the different JavaScript and CSS
+ files and minifies them. This can take a while depending on your computer.
-3. If it's done start the server using `node app.js`. This will start a simple [express.js](http://expressjs.com/) server that handles the requests.
+3. If it's done start the server using `node app.js`. This will start a simple
+ [express.js](http://expressjs.com/) server that handles the requests.
-If you only want to get the required html, JavaScript and CSS files see the __Standalone grunt target__ below.
+If you only want to get the required html, JavaScript and CSS files see the
+__Standalone grunt target__ below.
-###grunt targets
-#####Development target - `grunt dev`
+### grunt targets
+
+
+##### Development target - `grunt dev`
- useful for local development
- uses not minified js and css
- uses grunt watch to update code changes
-#####Standalone target - `grunt standalone`
+
+##### Standalone target - `grunt standalone`
- useful to create a minified version that is easy to deploy to your server
- minifies all the js and css files
- creates a `/build` folder that has all the required resources
- used to build the resources for the running application
-#####Standalone target with archive - `grunt standalone-archive`
+
+##### Standalone target with archive - `grunt standalone-archive`
- same as `grunt standalone` but creates archive of the build directory
- used for to create release files on github
-#####Continuous integration target - `grunt ci`
-- same targets as `grunt standalone` with additional testing of the generated files using [karma](http://karma-runner.github.io/)
+##### Continuous integration target - `grunt ci`
+
+- same targets as `grunt standalone` with additional testing of the generated
+ files using [karma](http://karma-runner.github.io/)
- used for travis continuous integration
-#####Default target - `grunt`
+
+##### Default target - `grunt`
- same as `standalone` except it won't create a build folder with all the ressources
More information about the tor-commits
mailing list