From d4717565cdfcdf77ce32a3635849b70679b87be4 Mon Sep 17 00:00:00 2001 From: Travis Goodspeed Date: Wed, 11 Dec 2019 01:25:57 -0500 Subject: [PATCH] Added build documentation and a Makefile. #1 --- .gitignore | 1 + Makefile | 17 +++++++++++++++++ README.md | 26 ++++++++++++++++++++++++++ 3 files changed, 44 insertions(+) create mode 100644 Makefile diff --git a/.gitignore b/.gitignore index 2b75303..f70d177 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,4 @@ /build /captures .externalNativeBuild +*~ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..3825bbb --- /dev/null +++ b/Makefile @@ -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 + + diff --git a/README.md b/README.md index a4c9b9e..d886925 100644 --- a/README.md +++ b/README.md @@ -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