Skip to content

Commit

Permalink
Update [email protected] and minor README changes
Browse files Browse the repository at this point in the history
  • Loading branch information
jeikabu committed Jan 13, 2020
1 parent b788bf0 commit c459f3c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "nng-sys"
version = "1.2.3-rc.1"
version = "1.2.4-rc.1"
authors = ["Nathan Kent <[email protected]>", "Jake W <[email protected]>"]

description = "Bindings to NNG (Nanomsg-Next-Generation) aka Nanomsg2"
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,22 @@ Rust FFI bindings to [NNG](https://github.com/nanomsg/nng):
![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
![Rustc 1.31+](https://img.shields.io/badge/rustc-1.31+-lightgray.svg)
[![travis](https://travis-ci.org/jeikabu/nng-rust.svg?branch=master)](https://travis-ci.org/jeikabu/nng-rust)
[![appveyor](https://ci.appveyor.com/api/projects/status/10fg3vxtk13rqy93/branch/master?svg=true)](https://ci.appveyor.com/project/jeikabu/nng-rust/branch/master)
[![Build Status](https://dev.azure.com/jeikabu/nng-rust/_apis/build/status/jeikabu.nng-rust?branchName=master)](https://dev.azure.com/jeikabu/nng-rust/_build/latest?definitionId=1&branchName=master)

## Usage

Version of this crate tracks NNG: `<NNG_version>-rc.<crate_version>` (e.g. `1.1.1-rc.2`).

To use the __latest crate__ for the most recent __stable version of NNG__ (1.2.x), in `Cargo.toml`:
```toml
nng-sys = "1.2.3-rc"
[dependencies]
nng-sys = "1.2.4-rc"
```

Requirements:
- [cmake](https://cmake.org/) in `PATH`
- On Linux/macOS: default generator is "Unix Makefiles"
- On Windows: default generator is "Visual Studio 15 2017 Win64"
- On Windows: default generator is generally latest version of Visual Studio installed
- _Optional_ libclang needed if using `build-bindgen` feature to run [bindgen](https://rust-lang.github.io/rust-bindgen/requirements.html)

## Features
Expand All @@ -41,13 +42,13 @@ Requirements:
_Example_) Re-generate FFI bindings with bindgen:
```toml
[dependencies]
nng-sys = { version = "1.1.1-rc", features = ["build-bindgen"] }
nng-sys = { version = "1.2.4-rc", features = ["build-bindgen"] }
```

_Example_) Disable stats and use Ninja cmake generator:
```toml
[dependencies.nng-sys]
version = "1.1.1-rc"
version = "1.2.4-rc"
default-features = false
features = ["cmake-ninja"]
```
Expand Down
2 changes: 1 addition & 1 deletion nng

0 comments on commit c459f3c

Please sign in to comment.