Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to the "design" group, in order to accommodate vessels with a variable keel or centerboard and some other changes #65

Merged
merged 15 commits into from
Jul 31, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions Gemfile

This file was deleted.

36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@ This repository contains the (working) specification for Signal K, defined in
JSON Schema files.


Signal K
--------

The Free and Open Source universal marine data exchange

SignalK is about publishing a common modern and open data format for marine
use. A format for the modern boat, compatible with NMEA, friendly to WiFi,
cellphones, tablets, and the Internet. A format available to everyone, where
anyone can contribute.

To get started, see the summary page and have a look through Navgauge Issue #4
to get a feel for where we started. Then join the mailinglist by sending an
email to [email protected] or follow the discussion via the
Signal K Google Groups forum.


Usage
-----

Expand Down Expand Up @@ -32,8 +48,10 @@ You can browse the Schema using the supplied docson viewer. Just open
index.html from a local webserver (otherwise the XHR requests won't work) in
your preferred browser to get started.


Validation
----------

Validation against SignalK schema can be done
- with a command line validator accepting JSON from stdin
- by explicitly calling validate packaged as an npm module
Expand All @@ -57,20 +75,4 @@ var result = validate(msg);
```
chai.use(require('signalk-schema).chaiModule);
tree.should.be.validSignalK;
```


Signal K
--------

The Free and Open Source universal marine data exchange

SignalK is about publishing a common modern and open data format for marine
use. A format for the modern boat, compatible with NMEA, friendly to WiFi,
cellphones, tablets, and the Internet. A format available to everyone, where
anyone can contribute.

To get started, see the summary page and have a look through Navgauge Issue #4
to get a feel for where we started. Then join the mailinglist by sending an
email to [email protected] or follow the discussion via the
Signal K Google Groups forum.
```
25 changes: 25 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# ROADMAP

Current version: **development**
Next stable release: **1**
Projected release date: --

*This file contains the roadmap towards the next stable release of the specification. It supersedes the older `TODO.md`.

Please treat this the same as the specification itself: when making changes, make them in a separate branch and only merge into master when discussed with the other contributors.*


## TODO

- [x] Decide on a versioning system
- [ ] Finalise the `design` group [#65](https://github.com/SignalK/specification/pull/65)
- [ ] Finalise the `sensors` group and define it's usage more clearly
- [ ] Review/rewrite the `alarms` group (@rob42)
- [ ] Come up with a `sails` group, remove `sails` from design (@fabdrol)
- [ ] Review the `resources` group
- [ ] Hygiene
- [ ] Add metadata to all groups (min, max, unit, descriptions, etc)
- [ ] Review all open PRs and branches, merge where required and remove when not
- [ ] Check for FIXMEs
- [x] Clean-up the repo
- [ ] Update documentation and publish blog posts and news on our first stable release.
14 changes: 0 additions & 14 deletions TODO.md

This file was deleted.

4 changes: 0 additions & 4 deletions _config.yml

This file was deleted.

3 changes: 0 additions & 3 deletions _includes/footer.html

This file was deleted.

16 changes: 0 additions & 16 deletions _includes/header.html

This file was deleted.

8 changes: 0 additions & 8 deletions _includes/sidebar.html

This file was deleted.

42 changes: 0 additions & 42 deletions _layouts/default.html

This file was deleted.

25 changes: 0 additions & 25 deletions bin/signalk-validate

This file was deleted.

7 changes: 0 additions & 7 deletions css/bootstrap.min.css

This file was deleted.

79 changes: 0 additions & 79 deletions css/jumbotron-narrow.css

This file was deleted.

19 changes: 0 additions & 19 deletions css/main.css

This file was deleted.

Loading