qupaloraarsuk/mtd-starter

Starter repo for building and configuring a Mother Tongues Dictionary

Mother Tongues Dictionaries Starter (MTD)

This is a starter kit for building a Mother Tongues Dictionary.

Please visit the repo or docs for more information.

Table of Contents

• Mother Tongues Dictionaries Starter (MTD)
  • Table of Contents
  • Background
  • Usage
  • Contributing
  • Acknowledgements
    • Contributors
  • License

Background

This project started as just a single dictionary for Gitxsan - a language spoken in Northern British Columbia, but it became quickly apparent that many communities also had the same problem. That is, they had some dictionary data but all of the options for sharing that data online were prohibitively expensive. MTD aims to make it easier to create online digital dictionary resources.

This is a starter kit for building your own dictionary.

Note - Just because you can make an online dictionary does not mean you should. Before making a dictionary, you must have clear consent from the language community in order to publish a dictionary. For some background on why this is important, please read sections 1 and 2.1 here

Usage

In order to create a Mother Tongues Dictionary you will need to adapt the configuration files in config and replace the data in data:

You can find out more about how to create these files against the MTD configuration schema by visiting the docs

Once you have those files, you can either create a dictionary programatically or using the command line interface. This repo also automatically builds with GitHub Actions.

Contributing

If something is not working, or you'd like to see another feature added, feel free to dive in! Open an issue or submit PRs. Help writing and clarifying documentation is also very welcome.

This repo follows the Contributor Covenant Code of Conduct.

Acknowledgements

Thank you to both Patrick Littell & Mark Turin for their contributions, guidance and support as well as institutional support from the First Peoples' Cultural Council and SSHRC Insight Grant 435-2016-1694, ‘Enhancing Lexical Resources for BC First Nations Languages’.

Thank you to all other contributors for support with improving MotherTongues, finding bugs and writing documentation.

Contributors

This project exists thanks to all the people who contribute.

License

MIT © Aidan Pine.