diff --git a/README.md b/README.md index 3d46c4e..75380c5 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Hi! This is a template for initializing an Android project in [MobileUp](https:/ After cloning the template: 1. Run the setup script to configure your application ID and JIRA key: - `./scripts/setup-project ` + `./scripts/setup-project ` [for Windows see](#calling-scripts-for-windows) 2. Replace application name and icon to the correct ones. 3. Remove the pokemons feature. It is created as an example. 4. Replace error text resources with text for your project. @@ -48,8 +48,16 @@ It consists of concrete features. Each feature has its own package which contain ### Git hooks To install the Git hooks for commit checks and automatic issue prefixes, simply run: - -`./scripts/setup-git-hooks` +`./scripts/setup-git-hooks` [for Windows see](#calling-scripts-for-windows) + +### Calling scripts for Windows +1. Install [Git Bash](https://gitforwindows.org/) +2. Go to your project folder and open Git Bash here (right click) +3. If your pre-commit failed by OUTPUT_MODULE_GRAPH_GENERATE. + Download and install [Graphviz](https://graphviz.org/download/) for Windows. + During installation, select "Add Graphviz to the system PATH for all users." and Reboot. +4. It is important to ensure that the java in the project (Project structure) + matches the java in JAVA_HOME (environment variables) ### Geminio templates - creates boilerplate code 1. Read installation instruction root/geminio/SETUP.MD