summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCasey Robinson <kc@rampantmonkey.com>2014-01-19 16:50:02 -0500
committerCasey Robinson <kc@rampantmonkey.com>2014-01-19 16:50:02 -0500
commit2160f1d5541797ddd1f820f10a1b8f18f467fbe0 (patch)
tree8d4638b41aa276b1704fe5dfb34095d8cfc63b35
parentb5f379c413fd16bf4f5b24fc26206fbc187ddf0a (diff)
downloadneighborhoods-2160f1d5541797ddd1f820f10a1b8f18f467fbe0.tar.gz
neighborhoods-2160f1d5541797ddd1f820f10a1b8f18f467fbe0.tar.bz2
neighborhoods-2160f1d5541797ddd1f820f10a1b8f18f467fbe0.zip
move boundary file format to separate file
-rw-r--r--README.md33
-rw-r--r--doc/boundary_file_format.md31
2 files changed, 32 insertions, 32 deletions
diff --git a/README.md b/README.md
index 387b7c8..eee8a53 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ To run `neighborhoods` with Leiningen installed use:
The required arguments are:
-- `neighborhood_boundaries` - a file containing the GPS coordinates for each possible neighborhood. See the __Boundary Format__ section for more details on the expected file format.
+- `neighborhood_boundaries` - a file containing the GPS coordinates for each possible neighborhood. See [doc/boundary\_file\_format.md](doc/boundary_file_format.md) for more details.
- `query_points` - a file containing the GPS coordinates for which the enclosing neighborhood is desired. See the __Query Points Format__ section for more details on the expected file format.
To run the test suite for `neighborhoods` with Leiningen use:
@@ -37,37 +37,6 @@ To run the test suite for `neighborhoods` with Leiningen use:
North End
Creston
-### Boundary Format
-
-The file consists of one or more neighborhoods each separated by a blank line.
-
-The first line of a neighborhood record is the name.
-Trailing colons in the name will be ignored by the parser, so feel free to use a colon to improve readability.
-
-After the name comes a list of coordinates which define the boundary.
-Each line defines a vertex on the boundary.
-The coordinates are given as a pair of floating point numbers separated by a comma.
-Negative coordinates are also permitted.
-Whitespace will be ignored, allowing for indentation and spacing around the comma.
-
-The first vertex and the last vertex must be identical, otherwise the border is not closed and the concept of inside or outside is undefined.
-
-Single neighborhood example:
-
- Baxter:
- -85.649292062877,42.9556000817054
- -85.6492705842355,42.9497012172617
- -85.6492578878531,42.948368509832
- -85.645020952015,42.9483342106272
- -85.641142705625,42.9483027964931
- -85.6394502285885,42.9482915914207
- -85.6394911133741,42.9510041671834
- -85.6395286822079,42.9540999424625
- -85.6395467912564,42.9555241741085
- -85.6452563130191,42.955562503948
- -85.6472890220423,42.9555759993448
- -85.649292062877,42.9556000817054
-
### Query Points Format
Each line of the query points file corresponds to an individual query.
diff --git a/doc/boundary_file_format.md b/doc/boundary_file_format.md
new file mode 100644
index 0000000..309ee58
--- /dev/null
+++ b/doc/boundary_file_format.md
@@ -0,0 +1,31 @@
+# Boundary File Format
+
+The file consists of one or more neighborhoods each separated by a blank line.
+
+The first line of a neighborhood record is the name.
+Trailing colons in the name will be ignored by the parser, so feel free to use a colon to improve readability.
+
+After the name comes a list of coordinates which define the boundary.
+Each line defines a vertex on the boundary.
+The coordinates are given as a pair of floating point numbers separated by a comma.
+Negative coordinates are also permitted.
+Whitespace will be ignored, allowing for indentation and spacing around the comma.
+
+The first vertex and the last vertex must be identical, otherwise the border is not closed and the concept of inside or outside is undefined.
+
+Single neighborhood example:
+
+ Baxter:
+ -85.649292062877,42.9556000817054
+ -85.6492705842355,42.9497012172617
+ -85.6492578878531,42.948368509832
+ -85.645020952015,42.9483342106272
+ -85.641142705625,42.9483027964931
+ -85.6394502285885,42.9482915914207
+ -85.6394911133741,42.9510041671834
+ -85.6395286822079,42.9540999424625
+ -85.6395467912564,42.9555241741085
+ -85.6452563130191,42.955562503948
+ -85.6472890220423,42.9555759993448
+ -85.649292062877,42.9556000817054
+