Merge branch 'in_memory_smt' into comm_tree_update

AUTHORS

@@ -0,0 +1,6 @@
+Daniele Di Benedetto <[email protected]>
+Oleksandr Iozhytsia <[email protected]>
+Volodymyr Babaiev <[email protected]>
+Maksym Vereshchak <[email protected]>
+Luigi Varriale <[email protected]>
+cronicc <[email protected]>

BUILD.md

@@ -0,0 +1,42 @@
+# Build guide
+
+The library compiles on the `1.51.0 stable` toolchain of the Rust compiler. To install Rust, first install `rustup` by following the instructions [here](https://rustup.rs/), or via your platform's package manager. Once `rustup` is installed, install the appropriate Rust toolchain by invoking:
+```bash
+rustup install 1.51.0
+```
+After that, use `cargo`, the standard Rust build tool, to build the library:
+```bash
+git clone https://github.com/HorizenOfficial/zendoo-sc-cryptolib.git
+cd zendoo-sc-cryptolib
+cargo build --release
+```
+This library comes with unit tests for each of the provided crates. Run the tests with:
+```bash
+cargo test --all-features 
+```
+Compiling with `adcxq`, `adoxq` and `mulxq` instructions can lead to a 30-70% speedup. These are available on most `x86_64` platforms (Broadwell onwards for Intel and Ryzen onwards for AMD). Run the following command:
+```bash
+RUSTFLAGS="-C target-feature=+bmi2,+adx" cargo test/build/bench --features asm
+```
+Tip: If optimising for performance, your mileage may vary with passing `--emit=asm` to `RUSTFLAGS`.
+
+## Java Jar build guide
+
+To be able to build a Java Jar package you can use the `build_jar.sh` script in `ci` folder.
+Requirements:
+1. Build on Linux (Ubuntu 18.04+, for example) with a cross compilation of a native Rust code for windows target as well.
+2. Add windows target support for `cargo`:
+    ```
+    rustup target add x86_64-pc-windows-gnu
+    rustup toolchain install stable-x86_64-pc-windows-gnu
+    ```
+3. Install maven, openjdk, clang, llvm, mingw:
+    ```
+    sudo apt-get install clang llvm maven gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64
+    ```
+4. Configure `mingw` to be able to cross compile the windows target of cryptolib dependencies:
+    ```
+    update-alternatives --install /usr/bin/x86_64-w64-mingw32-gcc x86_64-w64-mingw32-gcc /usr/bin/x86_64-w64-mingw32-gcc-posix 100
+    update-alternatives --install /usr/bin/x86_64-w64-mingw32-g++ x86_64-w64-mingw32-g++ /usr/bin/x86_64-w64-mingw32-g++-posix 100
+    ``` 
+5. Run `./ci/build_jar.sh`

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+## Contributing
+
+Contributions are welcomed! Bug fixes and new features can be initiated through GitHub pull requests. To speed the code review process, please adhere to the following guidelines:
+
+* Follow Horizen repositories' *code of conduct*
+* Follow Horizen repositories' *styling guide* 
+* Please gpg sign your commits 
+* Please make sure you push your pull requests to the development branch

LICENSE-MIT

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.