From e497e04f7057f8ec0e725415da5bad0f03864acb Mon Sep 17 00:00:00 2001 From: Jos van den Oever Date: Sat, 10 Dec 2016 18:08:15 +0100 Subject: [PATCH] fix for build instructions And clarification that nighty is required. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e8b74a519..2880fe5a4 100644 --- a/README.md +++ b/README.md @@ -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