summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJochen Topf <jochen@topf.org>2014-09-21 10:54:53 +0200
committerJochen Topf <jochen@topf.org>2014-09-21 10:54:53 +0200
commit30d951b644e30d505bdd45a4deb8fd2a996345cd (patch)
treed6e5dfa10a5ee8e28007e6cd630337ae801ece3b /README.md
parent64073b37f99321bffa0d3b2023f836d394123c58 (diff)
downloadtaginfo-30d951b644e30d505bdd45a4deb8fd2a996345cd.tar
taginfo-30d951b644e30d505bdd45a4deb8fd2a996345cd.tar.gz
README updates.
Diffstat (limited to 'README.md')
-rw-r--r--README.md65
1 files changed, 34 insertions, 31 deletions
diff --git a/README.md b/README.md
index 88acb64..b52fe34 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,16 @@
-Taginfo
-=======
+# Taginfo
-Brings together information about OpenStreetMap tags and makes it searchable and browsable.
+Brings together information about OpenStreetMap tags and makes it searchable
+and browsable.
-&nbsp;&nbsp;**Documentation:** the page [Taginfo](http://wiki.openstreetmap.org/wiki/Taginfo) at OpenStreetMap's wiki
+**Documentation:** See the
+[Taginfo](http://wiki.openstreetmap.org/wiki/Taginfo) page at the OpenStreetMap
+wiki.
-&nbsp;&nbsp;**Live System:** [taginfo.openstreetmap.org](http://taginfo.openstreetmap.org/)
+**Live System:** [taginfo.openstreetmap.org](http://taginfo.openstreetmap.org/)
-Files
------
+## Files
* `/sources` - import scripts
* `/web` - web user interface and API
@@ -17,8 +18,7 @@ Files
* `/tagstats` - C++ program to create database statistics
-Prerequisites
--------------
+## Prerequisites
It uses:
@@ -32,37 +32,40 @@ It uses:
* m4 binary
Install the Debian/Ubuntu packages:
-```bash
-$ sudo apt-get install curl m4 sqlite3 ruby-sqlite3 ruby-passenger libapache2-mod-passenger
+```sh
+$ sudo apt-get install curl m4 sqlite3 ruby-sqlite3
+$ sudo apt-get install ruby-passenger libapache2-mod-passenger
```
Install the Gems:
-```bash
+```sh
$ sudo gem install rack rack-contrib sinatra sinatra-r18n json
```
-There is a developer mailing list: [taginfo-dev](http://lists.openstreetmap.org/listinfo/taginfo-dev)
+There is a developer mailing list:
+[taginfo-dev](http://lists.openstreetmap.org/listinfo/taginfo-dev)
-Data Import
------------
+## Data Import
-See [Taginfo/Running](http://wiki.openstreetmap.org/wiki/Taginfo/Running) at OpenStreetMap's wiki.
+See [Taginfo/Running](http://wiki.openstreetmap.org/wiki/Taginfo/Running) at
+OpenStreetMap's wiki.
-Web User Interface
-------------------
+## Web User Interface
-You need a `/data` directory (where this `README.md` is). It must contain the sqlite database files created in the data import step or downloaded from page [taginfo.openstreetmap.org/download](http://taginfo.openstreetmap.org/download).
+You need a `/data` directory (in the parent directory of the directory where
+this `README.md` is). It must contain the sqlite database files created in the
+data import step or downloaded from page
+[taginfo.openstreetmap.org/download](http://taginfo.openstreetmap.org/download).
To start the web user interface:
-```bash
+```sh
$ cd web
$ ./taginfo.rb
```
-Javascript
-----------
+## Javascript
Taginfo uses the following Javascript libraries:
* jQuery 1.9.0
@@ -70,21 +73,21 @@ Taginfo uses the following Javascript libraries:
* [customSelect](http://adam.co/lab/jquery/customselect/)
* [tipsy](http://onehackoranother.com/projects/jquery/tipsy/)
* [jQuery Cookie](https://github.com/carhartl/jquery-cookie/)
-* Flexigrid (from [Google Code](http://code.google.com/p/flexigrid/) and [flexigrid.info](http://www.flexigrid.info/), but with changes and bugfixes)
+* Flexigrid (from [Google Code](http://code.google.com/p/flexigrid/) and
+ [flexigrid.info](http://www.flexigrid.info/), but with changes and bugfixes)
All the Javascript and CSS needed is already included.
-Thanks
-------
+## Thanks
* Stefano Tampieri, for the Italian translation
-* Ilya Zverev <<zverik@textual.ru>>, for the Russion translation
-* Jocelyn Jaubert <<jocelyn.jaubert@gmail.com>>, for the French translation
-* Jacek Buczyński <<jacekzlodzi@gmail.com>>, for the Polish translation
+* Ilya Zverev (zverik@textual.ru), for the Russion translation
+* Jocelyn Jaubert (jocelyn.jaubert@gmail.com), for the French translation
+* Jacek Buczyński (jacekzlodzi@gmail.com), for the Polish translation
-Author
-------
+## Author
+
+Jochen Topf (jochen@remote.org) - [Joto](http://wiki.openstreetmap.org/wiki/User:Joto)
-Jochen Topf <<jochen@remote.org>> AKA [Joto](http://wiki.openstreetmap.org/wiki/User:Joto)