summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCasey Robinson <kc@rampantmonkey.com>2014-01-19 16:52:31 -0500
committerCasey Robinson <kc@rampantmonkey.com>2014-01-19 16:52:31 -0500
commit487624cb83261fe551026a0c8d1f98b528d6a96d (patch)
tree3dee91140c0d3a5ce9e12244b53c5f5e952b9c88
parent2160f1d5541797ddd1f820f10a1b8f18f467fbe0 (diff)
downloadneighborhoods-487624cb83261fe551026a0c8d1f98b528d6a96d.tar.gz
neighborhoods-487624cb83261fe551026a0c8d1f98b528d6a96d.tar.bz2
neighborhoods-487624cb83261fe551026a0c8d1f98b528d6a96d.zip
move query points documentation to separate file
-rw-r--r--README.md14
-rw-r--r--doc/query_points_file_format.md11
2 files changed, 12 insertions, 13 deletions
diff --git a/README.md b/README.md
index eee8a53..1620e0e 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,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 [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.
+- `query_points` - a file containing the GPS coordinates for which the enclosing neighborhood is desired. See [doc/query\_points\_file\_format](doc/query_points_file_format.md) for more details..
To run the test suite for `neighborhoods` with Leiningen use:
@@ -37,18 +37,6 @@ To run the test suite for `neighborhoods` with Leiningen use:
North End
Creston
-### Query Points Format
-
-Each line of the query points file corresponds to an individual query.
-The query is a pair of numbers separated by a comma with optional whitespace.
-
-Example:
-
- -85.646282,42.912051
- -85.646726,42.913097
- -85.658789,42.951338
- -85.686883,42.936334
-
### Any Other Sections
### That You Think
### Might be Useful
diff --git a/doc/query_points_file_format.md b/doc/query_points_file_format.md
new file mode 100644
index 0000000..c01ffa4
--- /dev/null
+++ b/doc/query_points_file_format.md
@@ -0,0 +1,11 @@
+# Query Points File Format
+
+Each line of the query points file corresponds to an individual query.
+The query is a pair of numbers separated by a comma with optional whitespace.
+
+Example:
+
+ -85.646282,42.912051
+ -85.646726,42.913097
+ -85.658789,42.951338
+ -85.686883,42.936334