Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Expirement with using Markdown

  • Loading branch information...
commit 7faafe3166b0e8063530275b76bd1eaea31e37b4 1 parent 93f8ca5
@notnoop authored
Showing with 37 additions and 44 deletions.
  1. +37 −44 README.txt → README.md
View
81 README.txt → README.md
@@ -1,4 +1,3 @@
-=========
OpenBlock
=========
@@ -9,42 +8,40 @@ recently in the immediate geographic area.
OpenBlock began life as the open-source code released by
Everyblock.com in June 2009. Originally created by Adrian Holovaty
and the Everyblock team, it is now developed as an open-source (GPL)
-project at http://openblockproject.org.
+project at http://openblockproject.org .
Funding for the initial creation of Everyblock and the ongoing
-development of OpenBlock is provided by the Knight Foundation
-(http://www.knightfoundation.org/).
+development of OpenBlock is provided by the
+[Knight Foundation](http://www.knightfoundation.org/).
-====================
System Requirements
====================
-Linux, OSX, or some other Unix flavor.
+ * Linux, OSX, or some other Unix flavor.
-python 2.6 (2.7 might work)
-python-dev (python development libraries, whatever that's called on your system)
-postgresql
-postgis
-libgdal
-libxml2
-libxslt
-git
+ * `python 2.6` (2.7 might work)
+ * `python-dev` (python development libraries, whatever that's called on your system)
+ * `postgresql`
+ * `postgis`
+ * `libgdal`
+ * `libxml2`
+ * `libxslt`
+ * `git`
For system-specific lists of packages to install, see
-http://developer.openblockproject.org/wiki/InstallationRequirements
+[Installation Requirements](http://developer.openblockproject.org/wiki/InstallationRequirements)
and let us know if your system isn't listed there!
-=========================================
Quickstart: Install and Set Up Demo Site
=========================================
-These instructions will install the software in an isolated
+These instructions will install the software in an isolated
python environment using virtualenv ( http://pypi.python.org/pypi/virtualenv )
For detailed instructions and further steps, see obdemo/README.txt::
- $ git clone git://github.com/openplans/openblock.git openblock
- $ cd openblock
- $ python bootstrap.py
+ $ git clone git://github.com/openplans/openblock.git openblock
+ $ cd openblock
+ $ python bootstrap.py
Optionally you can edit obdemo/obdemo/real_settings.py at this stage.
@@ -53,14 +50,14 @@ configured.
Now you can set up the database and start the server::
- $ source bin/activate
- $ sudo -u postgres oblock setup_dbs
- $ oblock sync_all
- $ ./manage.py runserver
+ $ source bin/activate
+ $ sudo -u postgres oblock setup_dbs
+ $ oblock sync_all
+ $ ./manage.py runserver
If all goes well, you should be able to visit the demo site at:
-http://localhost:8000
+http://localhost:8000
If you encounter problems, double check that you have the basic system
requirements installed and then have a look at the step-by-step
@@ -71,14 +68,13 @@ http://groups.google.com/group/ebcode
or look for us in the #openblock IRC channel on irc.freenode.net.
-==============
For Developers
==============
This is a Django application, so it's highly recommended that you have
familiarity with the Django Web framework. The best places to learn
-are the official documentation (http://docs.djangoproject.com/) and
-the free Django Book (http://www.djangobook.com/). Note that OpenBlock
+are [the official documentation](http://docs.djangoproject.com/) and
+[the free Django Book](http://www.djangobook.com/). Note that OpenBlock
requires Django 1.1 and as of this writing does not yet work with
Django 1.2 or later.
@@ -87,11 +83,10 @@ time browsing around http://demo.openblockproject.org and/or
http://EveryBlock.com to get a feel for what this software does.
Also, for a light conceptual background on some of this, particularly the
-data storage aspect, watch the video "Behind the scenes of EveryBlock.com"
-here: http://blip.tv/file/1957362
+data storage aspect, watch the video
+["Behind the scenes of EveryBlock.com"](http://blip.tv/file/1957362)
-==========================================
Creating a Custom Site Based on OpenBlock
==========================================
@@ -105,7 +100,7 @@ pavement.py to get an idea of what needs doing, and/or modify it for
your own use.
Things You Will Need
-====================
+--------------------
Details are in ebpub/README.TXT, but briefly to get anything useful
out of your site, at mininum you will need to do the following:
@@ -136,7 +131,6 @@ site. You can dive into the other scripts that it calls to get more
details on how it all works.
-====================
Main Code Packages
====================
@@ -144,7 +138,7 @@ This distribution contains a number of packages, summarized below:
obdemo
-======
+------
The code and configuration used by http://demo.openblockproject.org.
This is useful as an example of how to set up your own site based on
@@ -154,7 +148,7 @@ package, and is set up with Boston, MA as the area of interest.
For more information, see obdemo/README.txt
ebpub
-=====
+-----
Publishing system for block-specific news, as used by EveryBlock.com.
@@ -164,7 +158,7 @@ that users see as well as the underlying data models. You need this.
For more information, see ebpub/README.TXT
ebdata
-======
+------
Code to help write scripts that import/crawl/parse data into ebpub.
@@ -174,16 +168,15 @@ useful; that is how you feed local news into the system.
For more information, see ebdata/README.TXT
obadmin
-=======
+-------
Administrative UI, installation and utilities package for OpenBlock
-==================
Other Packages
==================
ebblog
-======
+------
The blog application used by http://blog.everyblock.com
@@ -195,7 +188,7 @@ For more information, see ebblog/README.TXT
ebgeo
-=====
+-----
The eb map system. This is mostly used for rendering and serving map
tiles with Mapnik. This package is optional and not installed by default.
@@ -204,7 +197,7 @@ For more information, see ebgeo/README.TXT
ebinternal
-==========
+----------
Internal applications for the EveryBlock team.
@@ -221,9 +214,9 @@ For more information, see ebinternal/README.TXT
ebwiki
-======
+------
-A basic wiki.
+A basic wiki.
I'm not even sure if this is used on everyblock.com anymore.
Probably not useful to most OpenBlock users.
@@ -232,7 +225,7 @@ For more information, see ebwiki/README.TXT
everyblock
-===========
+-----------
This package contains code/templates that are specific to
EveryBlock.com. They were released to fulfill the terms of the grant
Please sign in to comment.
Something went wrong with that request. Please try again.