system HF Staff commited on
Commit
f2efba4
·
verified ·
1 Parent(s): 1474685

Mirror of b633e5a

Browse files
Files changed (1) hide show
  1. FORMAT.md +19 -0
FORMAT.md CHANGED
@@ -50,3 +50,22 @@ There are no timestamps, document ids, file names, device information or account
50
 
51
  The renderer used by rmpp-hwr (disc stamps every 0.5 px, pen width 4, height 48 for recognition) is in
52
  `rmpp-hwr/collect/collect.py` (`render`).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
 
51
  The renderer used by rmpp-hwr (disc stamps every 0.5 px, pen width 4, height 48 for recognition) is in
52
  `rmpp-hwr/collect/collect.py` (`render`).
53
+
54
+ ## Practice sentences (`texts/<code>.tsv`)
55
+
56
+ Sentences that people send through `[sentences]` issues and that pass the checks in `scripts/sentences.py`.
57
+ rmpp-hwr's `tools/texts.py` reads these files (a local checkout, else the raw URL below) and turns each one into
58
+ the practice topic `community`, so this format is a contract between the two repositories:
59
+
60
+ - One file per language: `<code>` is the language code from `languages.json`, the same code as rmpp-hwr's
61
+ `collect/texts/<code>/` folder (`ko`, `en`, ...). A file exists once a language has its first sentence.
62
+ - UTF-8, LF line ends, no BOM, no blank lines. Lines starting with `#` are comments; the first line names the
63
+ license.
64
+ - Every other line is `sentence<TAB>issue`: the sentence, then the number of the issue it came from (so a line can
65
+ be traced and removed). Readers use these two columns and ignore any later ones.
66
+ - A sentence is one line of 3-150 characters with no tab and no leading `#`, unique in its file.
67
+ - Lines are appended in the order they pass; a line can also be removed (withdrawal), so don't rely on line
68
+ numbers.
69
+ - Only the bot (`.github/workflows/sentences.yml`) writes these files.
70
+ - License: CC BY 4.0, attribution "rmpp-hwr-db contributors".
71
+ - URL: `https://raw.githubusercontent.com/lorancecall/rmpp-hwr-db/main/texts/<code>.tsv`