Skip to content

Commit

Permalink
Tweaks for v0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
neil-lindquist committed Aug 8, 2018
1 parent 1502d7d commit ad55427
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ This package provides functions to automate checking functions for type stabilit

### Setup

Run `Pkg.clone("https://github.com/Collegeville/TypeStability.jl.git")` to install TypeStability from its repository on Github. Then TypeStability can be `using`ed or `import`ed as normal.
Run `Pkg.clone("https://github.com/Collegeville/TypeStability.jl.git")` to install TypeStability from its repository on Github. Once TypeStability is added to Metadata.jl, then `Pkg.add(TypeStability)` can be used instead. Then TypeStability can be `using`ed or `import`ed as normal.


### Example

Documentation is located at collegeville.github.io/TypeStability.jl/latest/
Documentation is located at [collegeville.github.io/TypeStability.jl/stable/](collegeville.github.io/TypeStability.jl/stable/) or, for the lastest version, [collegeville.github.io/TypeStability.jl/latest/](collegeville.github.io/TypeStability.jl/latest/)

The function `enable_inline_stability_checks(::Bool)` enables running the stability checks, while the macro `@stablefunction(signatures, function)` handles running the checks.

Expand Down

0 comments on commit ad55427

Please sign in to comment.