Skip to content

Commit

Permalink
docs: add markdownlint ignore for html
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Oct 23, 2023
1 parent 763ed02 commit 89ac318
Showing 1 changed file with 27 additions and 19 deletions.
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
<img src="https://img.shields.io/github/license/hotosm/fmtm-splitter.svg" alt="License">
</a>
</p>
<!-- markdownlint-disable -->

---

Expand All @@ -43,6 +42,8 @@

---

<!-- markdownlint-enable -->

This is a program to split polygons into tasks using a variety of
algorythms. It is a class that can be used by other projects, but also
a standalone program. It was originally developed for the
Expand Down Expand Up @@ -94,32 +95,39 @@ and uses it to generate non square task boundaries. It can also be
adjusted to use the number of buildings in a task to adjust it's
size.

<img align="left" width="300px" src="https://github.com/hotosm/fmtm-splitter/blob/main/docs/images/Screenshot%20from%202023-08-06%2018-26-34.png"/>
![Split By Feature](https://github.com/hotosm/fmtm-splitter/blob/main/docs/images/Screenshot%20from%202023-08-06%2018-26-34.png)

## Custom SQL query

It is also possible to supply a custom SQL query to generate the
tasks.

# The fmtm-splitter program
## The fmtm-splitter program

options:
-h, --help show this help message and exit
-v, --verbose verbose output
-o OUTFILE, --outfile OUTFILE Output file from splitting
-m METERS, --meters METERS Size in meters if using square splitting
-b BOUNDARY, --boundary BOUNDARY Polygon AOI
-s SOURCE, --source SOURCE Source data, Geojson or PG:[dbname]
-c CUSTOM, --custom CUSTOM Custom SQL query for database]
Options:

```bash
-h, --help show this help message and exit
-v, --verbose verbose output
-o OUTFILE, --outfile OUTFILE Output file from splitting
-m METERS, --meters METERS Size in meters if using square splitting
-b BOUNDARY, --boundary BOUNDARY Polygon AOI
-s SOURCE, --source SOURCE Source data, Geojson or PG:[dbname]
-c CUSTOM, --custom CUSTOM Custom SQL query for database
```
This program splits a Polygon (the Area Of Interest)
The data source for existing data can'be either the data extract used by the XLSForm, or a postgresql database.
The data source for existing data can'be either the data extract
used by the XLSForm, or a postgresql database.
Examples:
examples:
fmtm-splitter -b AOI
fmtm-splitter -v -b AOI -s data.geojson
fmtm-splitter -v -b AOI -s PG:colorado
```bash
fmtm-splitter -b AOI
fmtm-splitter -v -b AOI -s data.geojson
fmtm-splitter -v -b AOI -s PG:colorado
Where AOI is the boundary of the project as a polygon
And OUTFILE is a MultiPolygon output file,which defaults to fmtm.geojson
The task splitting defaults to squares, 50 meters across
# Where AOI is the boundary of the project as a polygon
# And OUTFILE is a MultiPolygon output file,which defaults to fmtm.geojson
# The task splitting defaults to squares, 50 meters across
```

0 comments on commit 89ac318

Please sign in to comment.