Skip to content

Commit

Permalink
Addition of readme, changelog and gitignore.
Browse files Browse the repository at this point in the history
  • Loading branch information
dirtyformal authored Dec 31, 2020
2 parents bf72fda + fc95e41 commit a49265f
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
#VATNZ AIRAC Changelog
- [AIRAC 2013](#airac-2013)
- [Revision A (Initial Release)](#revision-a-initial-release)
- [Revision B](#revision-b)
- [Revision C](#revision-c)
- [Revision D](#revision-d)
- [Revision E](#revision-e)
- [AIRAC 2101 ()](#airac-2101-)
- [2101 (Yet to be released)](#2101-yet-to-be-released)


## AIRAC 2013

### Revision A (Initial Release)

Initial release of the NZ vatSys profile.

### Revision B

No recorded changes.

### Revision C

No recorded changes.

### Revision D

No recorded changes.

### Revision E

1. Ground RADAR Views - NV, TG, RO, DN, NP, GS, AP, NR, NS and PM have all been added. Their associated ground radar has also been added.

2. CPDLC updates - Small quality of life updates.

3. ATIS Text-to-Speech - Now pulls clouds from the METAR string.

4. Airspace - Fixed an issue where waypoints with the same name that were outside of NZ were being included in a flightplan.

## AIRAC 2101

### 2101 (Yet to be released)

**Note:** This AIRAC release is yet to be finalised. There are minimal changes to the NZ AIP this cycle.

1. Ownership parameters of ACU positions. All TMA positions owned by default.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

.DS_Store
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# VATNZ vatSys Dataset Project

The VATNZ vatSys Dataset project is an open source collaborative project allowing members of the VATNZ community to work together to create a high-quality dataset to use in vatSys.

A new sector file will be released in line with each AIRAC cycle (as long as significant changes warrant such as release).

## Releases

A **major dataset update** will be released in line with each AIRAC cycle, as long as there are significant enough changes to the NZAIP that warrants such a release. A **major dataset release** will follow the traditional 21xx format, with the first release of an AIRAC cycle being **Revision A** (ie 2101 Rev A)

A **minor dataset update** will be released between each AIRAC cycle, allowing for emergency fixes that cannot be held back until a major dataset release. This may include airspace updates, or minor configuration changes. Each subsequent dataset release will incrementally increase the revision letter.

VatSys allows for the remote updating of the vatSys dataset from the GitHub repository. This can only be done by a member of the VATNZ Board of Directors, or a delegated individual. As such, instructions for releasing a new Revision is not public.

A changelog is maintained [and provided here](.github/CHANGELOG.md). Update notifications are also posted in the #vatsys-discussion channel in the VATNZ Discord server.

## Contributing

A contribution guide will be written in due course and referenced here. You should contact either Cam or Tom in the first instance for instructions on how to contribute.

0 comments on commit a49265f

Please sign in to comment.