Skip to content
Permalink
Browse files

added Building.md

  • Loading branch information
crmulliner committed Aug 15, 2019
1 parent 5a77f93 commit b222d0b6274ea122cd010d53d99d0a006f589335
Showing with 42 additions and 0 deletions.
  1. +38 −0 Building.md
  2. +4 −0 Readme.md
@@ -0,0 +1,38 @@
# Building FwAnalyzer

## Requirements

- golang + dep + golang-lint
- Python
- filesystem tools such as e2tools, mtools

The full list of dependencies is tracked in the [Dockerfile](Dockerfile).

## Clone Repository

```sh
cd go/src/github.com/cruise-automation/
git clone git@github.com:cruise-automation/fwanalyzer.git
```

## Building

Before building you need to download some third party go libraries, run `make deps` before the first build.

```sh
cd go/src/github.com/cruise-automation/fwanalyzer
make deps
make
```

The `fwanalyzer` binary will be in `build/`.

# Testing

We have two types of tests: unit tests and integration tests, both tests will be triggered by running `make test`.
Tests rely on e2tools, mtools, squashfs-tools, and ubi_reader, as well as Python.

```sh
cd go/src/github.com/cruise-automation/fwanalyzer
make test
```
@@ -54,6 +54,10 @@ Example report:
}
```

## Building and Development

Follow the steps described in [Building](Building.md) to install all requirements and build FwAnalyzer.

## Using FwAnalyzer

Command line options

0 comments on commit b222d0b

Please sign in to comment.
You can’t perform that action at this time.