Skip to content

Commit

Permalink
Add travis, readme, license
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason Mobarak committed Jul 19, 2020
1 parent d23ae9d commit b188b66
Show file tree
Hide file tree
Showing 3 changed files with 145 additions and 0 deletions.
81 changes: 81 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# yamllint disable rule:line-length
---
sudo: required

language: rust

matrix:
include:

- os: linux

- os: osx
osx_image: xcode10

- os: windows

cache:
cargo: true

# before_script:
# - if [[ "$TRAVIS_OS_NAME" == "windows" ]]; then rm "C:/Program Files/Git/usr/bin/sh.exe"; fi

script:
- if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
docker run --rm -it -v "$PWD":/home/rust/src ekidd/rust-musl-builder \
cargo build --release;
fi
- if [[ "$TRAVIS_OS_NAME" == "osx" ]] || [[ "$TRAVIS_OS_NAME" == "windows" ]]; then
cargo build --release;
fi
- if [[ "$TRAVIS_OS_NAME" == "windows" ]]; then
cd target/release;
7z a -tzip ../../ntripping_windows.zip ntripping.exe;
cd ../..;
VERSION="$(git describe --always --tags --dirty)";
mv ntripping_windows.zip "ntripping-${VERSION}-windows-x86_64.zip";
ls -l;
fi
- if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then
tar -C "target/release" -czf ntripping_macos.tar.gz ntripping;
VERSION="$(git describe --always --tags --dirty)";
mv ntripping_macos.tar.gz "ntripping-${VERSION}-macos-x86_64.tar.gz";
ls -l;
fi
- if && [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
tar -C "target/x86_64-unknown-linux-musl/release" -czf ntripping_linux.tar.gz ntripping;
VERSION="$(git describe --always --tags --dirty)";
mv ntripping_linux.tar.gz "ntripping-${VERSION}-linux-x86_64.tar.gz";
ls -l;
fi

_github_api_key: &_github_api_key
api_key:
secure: secure: "XV1JaIjMGKaMwUSvWBHeXAD6+5o67mZedpROLmSPqklGjXUeeaLd08PmE+0XxQSI/O/s2d8oH5yX7H2luUQQ8hM/U33wRVuIGcsyM5QjeghNVylO/FdWnklTzDCeqdCXsJYhv/67VQbmapI9EfN0FErZgpbUWr7bT8fyDjfRCllsDWVqUf+aymhm4g3/sYWc1nbku7/L/ELrxbzob5YTQdGd2CuR+xp3i8hjGEFflc3UMuaI7skITEcBC1V93z4eHF7a1EZBPEESRxViGilU0/Bigb0qbBW56mrYLFdLZtM9JCSRNfajRNcy1htH+uZaBmvEdg1Y2BazCSlF/jBX50Tqke9mjgw2ZYyVm+Sm2ppUpd8ECXXy7BS1TI79VDvDJwcgaF3Vzt9k3x/nTlCsPwX0mWbmDLi01DAPTCBpuaecfUJbdcp3fTz649FXREJjARZcs8XJxOo13vUUVqfke0HClJluXjRur/lPQ1on0aTwJDGZ0m6cOzstxenWGWB3WkhxKSQocrejvuBZDa4Gc/iVTQuTo5lWOXx7D+1CNCDzF36/BPPzDnzGZ9N9/oFF2L5l9FNveeXdeL1rQjPXEUsGiSb6o+NgHYpQWFmKNYyrW9BKEkRuD3VtcEYsLC0bpj4ng0rr11vz6CideJ+D0dnE88FtDFSkXvtoQ3SLrdQ="

deploy:
- provider: releases
file_glob: true
file: "ntripping-*windows*.zip"
skip_cleanup: true
"on":
tags: true
condition: "$TRAVIS_OS_NAME = windows"
<<: *_github_api_key
- provider: releases
file_glob: true
file: "ntripping-*macos*.tar.gz"
skip_cleanup: true
"on":
tags: true
condition: "$TRAVIS_OS_NAME = osx"
<<: *_github_api_key
- provider: releases
file_glob: true
file: "ntripping-*linux*.tar.gz"
skip_cleanup: true
"on":
tags: true
condition: "$TRAVIS_OS_NAME = linux"
<<: *_github_api_key
...
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright 2020 Swift Navigation Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# [ntripping][ntripping]

A debug utility for monitoring and inspecting NTRIP. This utility uses the same
libraries and mechanisms as the Piksi Multi.

## Install a pre-built package

Visit [the releases page](https://github.com/swift-nav/ntripping/releases) to
find a pre-built package for your platform.

## Building from source.

Building these utilities requires Rust. First [install
Rust](https://rustup.rs/) then to build and install, run the following from a
checkout of this repository:

```
cargo install --path .
```

## Usage

The `ntripping` utility has the following usage:

ntripping 0.1.0
NTRIP command line client.

USAGE:
ntripping [FLAGS] [OPTIONS]

FLAGS:
-h, --help Prints help information
-V, --version Prints version information
-v, --verbose

OPTIONS:
--height <height> [default: -5.549358852471994]
--lat <lat> [default: 37.77101999622968]
--lon <lon> [default: -122.40315159140708]
--url <url> [default: na.skylark.swiftnav.com:2101/CRS]

Different resources can be requested from different locations. By default, a San
Francisco latitude, longitude, and height will be used.

[ntripping]: https://github.com/swift-nav/ntripping

0 comments on commit b188b66

Please sign in to comment.