Skip to content

Commit

Permalink
Update documentation to clarify that dictionary data and images shoul…
Browse files Browse the repository at this point in the history
…d now be fetched from the Github releases for nzsl-dictionary-scripts
  • Loading branch information
joshmcarthur committed Feb 12, 2023
1 parent 2138ff4 commit b35f1a0
Showing 1 changed file with 20 additions and 3 deletions.
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

0 comments on commit b35f1a0

Please sign in to comment.