Skip to content

Commit

Permalink
Update README and add coverage
Browse files Browse the repository at this point in the history
  • Loading branch information
helgee committed Feb 2, 2018
1 parent 2b84a83 commit 1e994fe
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 10 deletions.
8 changes: 8 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,11 @@ notifications:
# - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
# - julia -e 'Pkg.add("BinDeps"); Pkg.checkout("BinDeps")'
# - julia -e 'Pkg.clone(pwd()); Pkg.build("SPICE"); Pkg.test("SPICE"; coverage=true)'
after_success:
# push coverage results to Coveralls
- julia -e 'cd(Pkg.dir("SPICE")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
# push coverage results to Codecov
- julia -e 'cd(Pkg.dir("SPICE")); Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())'
# - julia -e 'Pkg.add("Documenter")'
# - julia -e 'cd(Pkg.dir("SPICE")); include(joinpath("docs", "make.jl"))'

25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
# SPICE.jl

[![Build Status](https://travis-ci.org/JuliaAstrodynamics/SPICE.jl.svg?branch=master)](https://travis-ci.org/JuliaAstrodynamics/SPICE.jl)
[![Build status](https://ci.appveyor.com/api/projects/status/2mjf3djfw39gyl0k?svg=true)](https://ci.appveyor.com/project/JuliaAstrodynamics/spice-jl)
*Julia wrapper for NASA NAIF's SPICE toolkit*

## Installation
[![Build Status Unix][travis-badge]][travis-url] [![Build Status Windows][av-badge]][av-url] [![Coveralls][coveralls-badge]][coveralls-url] [![Codecov][codecov-badge]][codecov-url] [![Docs Stable][docs-badge-stable]][docs-url-stable] [![Docs Latest][docs-badge-latest]][docs-url-latest]

On Linux and OSX CMake and a C compiler are needed.
## Installation

```julia
Pkg.clone("https://github.com/JuliaAstrodynamics/SPICE.jl.git")
# Pkg.add("SPICE")
```

## Roadmap

* [X] Julia-native error handling
* [ ] Wrap the most used [CSPICE APIs](https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/info/mostused.html)
* [ ] Provide julian APIs
[travis-badge]: https://travis-ci.org/JuliaAstro/SPICE.jl.svg?branch=master
[travis-url]: https://travis-ci.org/JuliaAstro/SPICE.jl
[av-badge]: https://ci.appveyor.com/api/projects/status/13l2bwswxbl1g8cq?svg=true
[av-url]: https://ci.appveyor.com/project/helgee/spice-jl
[coveralls-badge]: https://coveralls.io/repos/github/JuliaAstro/SPICE.jl/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/JuliaAstro/SPICE.jl?branch=master
[codecov-badge]: http://codecov.io/github/JuliaAstro/SPICE.jl/coverage.svg?branch=master
[codecov-url]: http://codecov.io/github/JuliaAstro/SPICE.jl?branch=master
[docs-badge-latest]: https://img.shields.io/badge/docs-latest-blue.svg
[docs-url-latest]: https://juliaastro.github.io/SPICE.jl/latest
[docs-badge-stable]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-url-stable]: https://juliaastro.github.io/SPICE.jl/stable

0 comments on commit 1e994fe

Please sign in to comment.