Skip to content

Commit

Permalink
Merge pull request #74 from ODNZSL/release/v45
Browse files Browse the repository at this point in the history
Version 45
  • Loading branch information
joshmcarthur authored Mar 14, 2023
2 parents 3f4c7b6 + 4ba7369 commit 66bdd9f
Show file tree
Hide file tree
Showing 5 changed files with 4,990 additions and 9,627 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,4 @@ proguard/
# NZSL images (fetched by script)
app/src/main/assets/images/*
!app/src/main/assets/images/.gitkeep
.DS_Store
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,28 @@

This repository holds the code necessary to develop the NZSL Dictionary App for Android. This codebase can be imported into Android Studio and you are invited to fork it to add features and bug fixes.

The original code was developed by [Greg Hewgill](http://hewgill.com/) and generously gifted to the [Deaf Studies Research Unit](http://www.victoria.ac.nz/lals/centres-and-institutes/dsru) of [Victoria University of Wellignton](http://www.victoria.ac.nz/). It is maintained by [Ackama](https://www.ackama.com/).
The original code was developed by [Greg Hewgill](http://hewgill.com/) and generously gifted to the [Deaf Studies Research Unit](http://www.victoria.ac.nz/lals/centres-and-institutes/dsru) of [Victoria University of Wellignton](http://www.victoria.ac.nz/). It is maintained by [Ackama](https://www.ackama.com/).

# Dictionary data

The dictionary is updated monthly, with data released publicly at https://github.com/ODNZSL/nzsl-dictionary-scripts/releases.

While we keep a version of the dictionary database up-to-date in this repository, you
can download the latest version at any time by placing the "nzsl.dat" file in `app/src/main/assets/db/nzsl.dat`.

# Missing images?

This repository does not include images for the database of signs. We have created [an importer script](https://github.com/ODNZSL/nzsl-dictionary-scripts) that will fetch the latest images from the VUW servers and place them in the correct folder. You should run this once when you start development. Signs are updated every few months.
This repository does not include images for the database of signs. Just like the dictionary data, we prepare a public export of published sign data monthly, including preprocessed images for use in the native Android and iOS apps.

Find the latest release at https://github.com/ODNZSL/nzsl-dictionary-scripts/release, from which you can download `assets.tar.gz`, and place the extracted 'assets' folder at `app/src/main/assets/images/signs`.

e.g.

```
tar -xf assets.tar.gz
rm -r app/src/main/assets/images/signs
mv assets app/src/main/assets/images/signs
```

# Android and iOS features

Expand All @@ -18,7 +35,7 @@ If you find a bug and would like to report it, please open a Github issue. If yo

# Contributions

Contributions are welcome for this project. Please comment on an issue if you are willing to work on it and an administrator will give you further information if required.
Contributions are welcome for this project. Please comment on an issue if you are willing to work on it and an administrator will give you further information if required.
To contribute, make a fork of this repository and branch off the master branch.
Create a pull request against the ODNZSL master branch.
Two approvals are required before a PR can be merged.
Expand Down
8 changes: 4 additions & 4 deletions app/build.gradle
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
apply plugin: 'com.android.application'

android {
compileSdkVersion 29
compileSdkVersion 31

defaultConfig {
applicationId "com.hewgill.android.nzsldict"
minSdkVersion 14
targetSdkVersion 29
targetSdkVersion 31
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
versionCode 39
versionName "39"
versionCode 45
versionName "45"
}

buildTypes {
Expand Down
3 changes: 2 additions & 1 deletion app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
<activity
android:name=".NZSLDictionary"
android:label="@string/app_name"
android:windowSoftInputMode="stateHidden">
android:windowSoftInputMode="stateHidden"
android:exported="true">
<intent-filter>
<action android:name="android.intent.action.MAIN" />

Expand Down
Loading

0 comments on commit 66bdd9f

Please sign in to comment.