fix for build instructions

And clarification that nighty is required.
This commit is contained in:
Jos van den Oever
2016-12-10 18:08:15 +01:00
committed by GitHub
parent dff022b30a
commit e497e04f70

View File

@@ -33,11 +33,13 @@ It will walk you through getting a wikipedia search engine up and running in a f
# Compiling
Tantivy requires Rust Nightly because it uses requires the features [`box_syntax`](https://doc.rust-lang.org/stable/book/box-syntax-and-patterns.html), [`optin_builtin_traits`](https://github.com/rust-lang/rfcs/blob/master/text/0019-opt-in-builtin-traits.md), and [`conservative_impl_trait`](https://github.com/rust-lang/rfcs/blob/master/text/1522-conservative-impl-trait.md).
By default, `tantivy` uses a git submodule called `simdcomp`.
After cloning the repository, you will need to initialize and update
the submodules. The project can then be built using `cargo`.
git clone git@github.com:fulmicoton/tantivy.git
cd tantivy
git submodule init
git submodule update
cargo build