Skip to content

Commit

Permalink
Added build documentation and a Makefile. #1
Browse files Browse the repository at this point in the history
  • Loading branch information
travisgoodspeed committed Dec 11, 2019
1 parent efa2e82 commit d471756
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
/build
/captures
.externalNativeBuild
*~
17 changes: 17 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

help:
@echo "You probably want to run 'make clean assemble install'."
@echo "Install Android Studio and Gradle first."

.PHONY: clean build assemble install

clean:
./gradlew clean
build:
./gradlew build
assemble:
./gradlew assemble
install:
./gradlew installDebug


26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,32 @@ Cheers from Yverdon les Bains,

--Travis Goodspeed

## Building in Android Studio

GoodV is developed with [Android
Studio](https://developer.android.com/studio). Begin by choosing
"Check out project from Version Control", then give
`https://github.com/travisgoodspeed/GoodV` as the URL.

With a little luck it will simply compile, but there might be a
mismatch of the Gradle version and the IDE's plugin. If the Gradle
sync fails, either try the "Install missing platforms and sync
project" option or update the project's build target to something more
modern. Sometimes it helps to jump forward in fewer target revisions,
rather than trying to go all the way to the latest major release.

## Building with the Gradle Wrapper

While Android Studio is damned handy as an IDE, some of us stubborn
ol' fogeys demand a way to compile code from the command line like a
proper gentleman would. For that, use `./gradlew` on Unix or
`graldew.bat` in Windows.

You can compile with `./gradlew clean` and then `./gradlew assemble`,
then install with `./gradlew installDebug`. For a full list of
targets run `./gradle tasks`, and for convenience, a `Makefile`
wrapper is also included.

## Related Projects

[GoodTag](https://github.com/travisgoodspeed/goodtag) is an open
Expand Down

0 comments on commit d471756

Please sign in to comment.