Skip to content

Add instructions for use scripts for Windows #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MaximZI-droid wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add instructions for use scripts for Windows #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <new.application.id> <JIRA_PROJECT_KEY>`
`./scripts/setup-project <new.application.id> <JIRA_PROJECT_KEY>` [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.
Expand Down Expand Up @@ -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
Expand Down