Skip to content

Commit

Permalink
up(LICENSE): fix the licensing
Browse files Browse the repository at this point in the history
mv(*.{awk,sed} scripts): move scripts
add(assets): assets for README
up(README, .gitignore): reflect above
  • Loading branch information
matthmr committed Dec 30, 2022
1 parent 4c774d0 commit c0a0cb4
Show file tree
Hide file tree
Showing 7 changed files with 752 additions and 15 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Binary
*.o
romaji

# Dev
*.task

# Assets
*.dot
680 changes: 671 additions & 9 deletions LICENSE

Large diffs are not rendered by default.

9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ awk -F: '/^([0-9]+:|>> 0:) <[^mcQ]/ {

I wrap this shell code in a function that gets sourced by my `~/.zshrc` so I can
call this by passing the function name, instead of the script name but whichever
implementation works. The awk script will be in the repository root as `kkc.awk`,
implementation works. The awk script will be in the repository root as `scripts/kkc.awk`,
it can be used in the output of piped kkc.

Usage alongside `kkc.awk` *should* look as such:
Usage alongside `scripts/kkc.awk` *should* look as such:

```txt
$ romaji "kore ha nani" | sed 's/$/ 4/' | kkc | kkc.awk
Expand All @@ -52,7 +52,10 @@ $ romaji "kore ha nani" | sed 's/$/ 4/' | kkc | kkc.awk

This repository also includes a sed script for common transliteration of misleading
particles like `wa` (は) as in (kimi wa - 君は) & `e` as in (nihon e - 日本へ).
The script is `norm.sed`.
The script is `scripts/norm.sed`. Also, this project can integrate with [kakasi] to have
full conversion as shown by the graph:

![conversion](assets/conversion.svg)

## License

Expand Down
66 changes: 66 additions & 0 deletions assets/conversion.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions norm.sed

This file was deleted.

File renamed without changes.
3 changes: 3 additions & 0 deletions scripts/norm.sed
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
s/ wa \| wa$/ ha /g
s/ e \| e$/ he /g
s/ o \| o$/ wo /g

0 comments on commit c0a0cb4

Please sign in to comment.