Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MaJerle committed Dec 8, 2019
1 parent e82f172 commit 1615628
Showing 1 changed file with 23 additions and 18 deletions.
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,33 @@
# GPS NMEA 0183 Parser

Platform independent GPS NMEA parser for embedded systems
Platform independent GPS NMEA parser for embedded systems.

<h3><a href="http://docs.majerle.eu/projects/gps-nmea-parser">Documentation</a></h3>

## Features

- Platform independent, easy to port
- Written in C99 language
- Built-in support for `4` GPS statements
- `GPGGA` or `GNGGA`: GPS fix data
- `GPGSA` or `GNGSA`: GPS active satellites and dillusion of position
- `GPGSV` or `GNGSV`: List of satellites in view zone
- `GPRMC` or `GNRMC`: Recommended minimum specific GPS/Transit data
- Optional `float` or `double` floating point units
- Low-level layer is separated from application layer, thus allows you to add custom communication with GPS device
- Works with operating systems
- Works with different communication interfaces
- User friendly MIT license
* Written in ANSI C99
* Platform independent, easy to use
* Built-in support for 4 GPS statements
* ``GPGGA`` or ``GNGGA``: GPS fix data
* ``GPGSA`` or ``GNGSA``: GPS active satellites and dillusion of position
* ``GPGSV`` or ``GNGSV``: List of satellites in view zone
* ``GPRMC`` or ``GNRMC``: Recommended minimum specific GPS/Transit data
* Optional ``float`` or ``double`` floating point units
* Low-level layer is separated from application layer, thus allows you to add custom communication with GPS device
* Works with operating systems
* Works with different communication interfaces
* User friendly MIT license

## Documentation
## Contribute

Full API documentation with description and examples is available and is regulary updated with the source changes
We always welcome new contributors. To be as efficient as possible, we recommend:

http://majerle.eu/documentation/gps/html/index.html
1. Fork Github repository
2. Respect C style & coding rules used by the library
3. Make a pull request to develop branch with new features or bug fixes

## Contribution
Alternatively you may:

I invite you to give feature request or report a bug. Please use issues tracker.
1. Report a bug
2. Ask for a feature request

0 comments on commit 1615628

Please sign in to comment.