Skip to content
This repository has been archived by the owner on Dec 7, 2019. It is now read-only.

update build instructions #141

Merged
merged 3 commits into from
Apr 29, 2018
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,27 @@ Composer works great in combination with [Swarmer][swarmer] — another tool we'

### How to build

Dependencies: you only need `docker` and `bash` installed on your machine.
#### To build composer
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Build Composer


environmental variable ANDROID_HOME must be set.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capital E, wrap ANDROID_HOME with ` :)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And afaik it's called environment variable, not environmental hehe

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:greenpeace:


```console
./gradlew build
```

#### To build html-report
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Build HTML report module"?


you need `npm` and `nodejs` packages installed.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dependencies: npm and nodejs.


```console
cd html-report
npm install
npm build
```

#### All-in-one script (used in Travis build)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we put this one at the top of "How to build"? I don't want people install npm and stuff to build Composer


you only need `docker` and `bash` installed on your machine.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dependencies: docker and bash.


```console
ci/build.sh
Expand Down