Skip to content

Commit 6902016

Browse files
committed
Add MIT license and public-facing docs
1 parent aa781bb commit 6902016

File tree

6 files changed

+36
-90
lines changed

6 files changed

+36
-90
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,8 @@ ofmx_lk.zip
3030
ofmx_lk/
3131
data/ofmx_lk.zip
3232
data/ofmx_lk/
33+
34+
# Local-only docs
35+
AGENTS.md
36+
PROGRESS.md
37+
TODO.md

AGENTS.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 SkyAlgorithm
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

PROGRESS.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ Importer and schema are functional for the LK sample dataset. See `TODO.md` for
1616
- `sql/migrations/` PostGIS schema migrations.
1717
- `config/` example configuration files.
1818
- `tests/` minimal unit tests for parser and CLI.
19-
- `TODO.md` roadmap and design checklist.
20-
- `AGENTS.md` contributor guide for this repository.
2119

2220
## Current Capabilities
2321
- Streaming XML parsing for OFMX datasets (Ahp, Rwy, Rdn, Ase, Dpn, Ndb/Vor/Dme).
@@ -56,3 +54,13 @@ docker run --rm \
5654
The LK sample data is fetched on demand into `data/ofmx_lk/` via `scripts/fetch_ofmx.sh` and is ignored by git.
5755

5856
Airspace records in the LK sample reuse `AseUid/@mid`, so `ofmx.airspaces.ofmx_id` is not unique. The schema uses a composite uniqueness constraint on `(ofmx_id, region, code_id, code_type, name)` to preserve distinct entries while keeping imports idempotent.
57+
58+
## Roadmap
59+
- Expand parser coverage for additional OFMX features (procedures, routes, obstacles).
60+
- Add integration tests that validate full imports against a disposable PostGIS instance.
61+
62+
## License
63+
MIT. See `LICENSE`.
64+
65+
## Data Sources
66+
OFMX data is sourced from OpenFlightMaps snapshots. Review their terms and attribution requirements before redistribution.

TODO.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

0 commit comments

Comments
 (0)