Add build instructions in README

[Razican]

We currently have no building instructions in the README file. This means that somebody willing to build the project could have issues. This is even more important now that in Windows the build script requires --features no-color to be added.

[RCMainak]

Hello, I am having issue building the analyzer from source. I tried to build using

cargo build --verbose

I get the following error

error: Could not compile `super-analyzer`.

Caused by:
  process didn't exit successfully: `rustc --crate-name super src/main.rs --crate-type bin --emit=dep-info,link -C panic=unwind -C codegen-units=1 -C debuginfo=2 --cfg 'feature="beta"' --cfg 'feature="default"' -C metadata=dfaa622ef2ef8d0d -C extra-filename=-dfaa622ef2ef8d0d --out-dir <folder_location>/super/target/debug/deps -C incremental=<folder_location>/super/target/debug/incremental -L dependency=<folder_location>/super/target/debug/deps --extern abxml=<folder_location>/super/target/debug/deps/libabxml-cebbf29828bfe302.rlib --extern bytecount=<folder_location>/super/target/debug/deps/libbytecount-d73af299d75940b1.rlib --extern chrono=<folder_location>/super/target/debug/deps/libchrono-d590ff6dbeafc558.rlib --extern clap=<folder_location>/super/target/debug/deps/libclap-181d1e74655946d6.rlib --extern colored=<folder_location>/super/target/debug/deps/libcolored-b08b5fa23be1b9bd.rlib --extern env_logger=<folder_location>/super/target/debug/deps/libenv_logger-982c5feec8e054b0.rlib --extern error_chain=<folder_location>/super/target/debug/deps/liberror_chain-e017a2189e8214ec.rlib --extern handlebars=<folder_location>/super/target/debug/deps/libhandlebars-6d8e6ea658ea196c.rlib --extern lazy_static=<folder_location>/super/target/debug/deps/liblazy_static-c65e0353298d5d83.rlib --extern log=<folder_location>/super/target/debug/deps/liblog-596a73bf2e276760.rlib --extern md5=<folder_location>/super/target/debug/deps/libmd5-55d9e1188e0058a4.rlib --extern open=<folder_location>/super/target/debug/deps/libopen-cc8d1a23e24f286e.rlib --extern regex=<folder_location>/super/target/debug/deps/libregex-74ca7bcc770b03d4.rlib --extern rustc_serialize=<folder_location>/super/target/debug/deps/librustc_serialize-9b7a08da27d8f639.rlib --extern serde=<folder_location>/super/target/debug/deps/libserde-cf575680f8cec4cf.rlib --extern serde_json=<folder_location>/super/target/debug/deps/libserde_json-f180958436d91fad.rlib --extern sha1=<folder_location>/super/target/debug/deps/libsha1-1a3fd9ac364cf43f.rlib --extern sha2=<folder_location>/super/target/debug/deps/libsha2-b5d45380dedab45e.rlib --extern toml=<folder_location>/super/target/debug/deps/libtoml-dd12c0e6f60f8fb9.rlib --extern xml=<folder_location>/super/target/debug/deps/libxml-6aca398a5f69d8f9.rlib -L native=<folder_location>/super/target/debug/build/backtrace-sys-d2850ff9977af823/out/.libs -L native=<folder_location>/super/target/debug/build/bzip2-sys-d9171ea07849e20d/out -L native=<folder_location>/super/target/debug/build/miniz-sys-1eaee9085da99102/out` (exit code: 1)

I am also get few unused result errors listed below.

error: unused result
   --> src/results/mod.rs:144:17
error: unused result
   --> src/results/mod.rs:147:17
error: unused result
   --> src/results/mod.rs:150:17
error: unused result
   --> src/results/mod.rs:153:17
error: unused result
   --> src/results/mod.rs:156:17
error: unused result
   --> src/config.rs:294:13
error: unused result
   --> src/config.rs:679:21

I didn't any changes in the code. I am using Ubuntu 18.04 with rust 1.29.0. Sorry, if this is not the right place to post this issue.

Thanks for building such a nice tool.

[Chuky9]

Hello @RCMainak!

After reading your output issue, I would suggest you to compile "develop" branch version as "master" one might not compile with new version of Rust. Would you mind to try that and let us know if it compiles?

Do not hesitate to contact us for further issues!

Thanks for using SUPER!

Best regards,

[Razican]

Hi @RCMainak, the issue you found should be fixed even in the master branch now. Please, let us know if this is not the case.

[Razican]

I'm closing this issue, since the build instructions now include Windows in superanalyzer.rocks.