Skip to content

Commit

Permalink
Deal with READMEs.
Browse files Browse the repository at this point in the history
  • Loading branch information
eddieantonio committed Jul 22, 2019
1 parent 68013b3 commit 4577bc1
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 34 deletions.
39 changes: 5 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,12 @@ Plains Cree Touch Keyboard generator

[![Build Status](https://travis-ci.org/eddieantonio/plains-cree-touch-keyboard.svg?branch=master)](https://travis-ci.org/eddieantonio/plains-cree-touch-keyboard)

I've written code here that generates a `.keyman-touch-layout` JSON file
and a `.kmn` Keyman programming language file, that, put together,
create a keyboard for writing ᒐᐦᑭᐯᐘᓯᓇᐦᐃᑫᐏᐣ (Plains Cree syllabics).
Source code for a Plains Cree syllabics keyboard for Keyman and its
generator. See the code generator in **release/nrc/nrc_crk_cans/extras**.

More documentation coming soon!


Requirements
------------

* Python 3.7+
* (optional) `make`
* (optional) [Black](https://github.com/python/black)

The files can then be packaged in [Keyman
Developer](https://keyman.com/developer/).


Usage
-----

Run `make` to build `nrc_cr_cans.keyman-touch-layout` and `nrc_cr_cans.kmn`.

If you don't have `make`, you can run:

python3 generate-touch-layout.py
python3 generate-kmn.py


Copying
COPYING
-------

Copyright © 2019 Eddie Antonio Santos of the National Research Council
Canada <Eddie.Santos@nrc-crnc.gc.ca>.
Keyboard (C) 2019 National Research Council Canada. Released under the MIT license.

This code is distributed under the terms of the [Mozilla Public License
(MPL) 2.0](https://www.mozilla.org/en-US/MPL/2.0/). See LICENSE for the
full license text.
Code generator (c) 2019 National Research Council Canada. Released under the MPL-2.0 license.
37 changes: 37 additions & 0 deletions release/nrc/nrc_crk_cans/extras/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@

Plains Cree Touch Keyboard generator
====================================

I've written code here that generates a `.keyman-touch-layout` JSON file
and a `.kmn` Keyman programming language file, that, put together,
create a keyboard for writing ᒐᐦᑭᐯᐘᓯᓇᐦᐃᑫᐏᐣ (Plains Cree syllabics).


Requirements
------------

* Python 3.7+
* (optional) `make`
* (optional) [Black](https://github.com/python/black)


Usage
-----

Run `make` to build `nrc_crk_cans.keyman-touch-layout` and `nrc_crk_cans.kmn`.

If you don't have `make`, you can run:

python3 generate-touch-layout.py ../source/nrc_crk_cans.keyman-touch-layout
python3 generate-kmn.py ../source/nrc_crk_cans.kmn


Copying
-------

Copyright © 2019 Eddie Antonio Santos of the National Research Council
Canada <Eddie.Santos@nrc-crnc.gc.ca>.

This code is distributed under the terms of the [Mozilla Public License
(MPL) 2.0](https://www.mozilla.org/en-US/MPL/2.0/). See LICENSE for the
full license text.

0 comments on commit 4577bc1

Please sign in to comment.