From e6ea5bfe270ba81e0dc6b85538070781753253d9 Mon Sep 17 00:00:00 2001 From: Elnu <9874955+ElnuDev@users.noreply.github.com> Date: Mon, 14 Feb 2022 21:15:46 -0800 Subject: [PATCH] Create README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..54888c7 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +
+ +# 字(じ)ちゃん + +
+ +字(じ)ちゃん is the Discord bot for the Tegaki Tuesday handwriting challenge. For more information on the challenge, please visit the [website](https://tegakituesday.com). + +She is written in Rust using the [serenity](https://github.com/serenity-rs/serenity) crate, and the overall structure of the codebase is based on [official example 6](https://github.com/serenity-rs/serenity/tree/current/examples/e06_sample_bot_structure). If you want to make a Discord bot using serenity, please refer to the official examples rather than this repository because I probably don't know what I'm doing. + +Stroke order diagrams are sourced via linking from [mistval/kanji_images](https://github.com/mistval/kanji_images). + +Kanji lists are modified from [ffe4/kanji-lists](https://github.com/ffe4/kanji-lists), with the addition of [Hyōgai kanji](https://en.wikipedia.org/wiki/Hy%C5%8Dgai_kanji). + +### Usage + +You are free to use the code in this repository however you like under the license terms, *provided* you do not use the "Tegaki Tuesday" or "字ちゃん" names in your derivative projects. Thank you!