diff --git a/README.md b/README.md index d51b111..2d09b3a 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,17 @@ # Kanimaji -Add animated kanji strokes to your app! +Kanji stroke order animations for flutter. -## Features +> [!WARNING] +> This library is still not finished, take the contents and promises of this README with a grain of salt. -This library is a port of [Kanimaji][kanimaji], a library for animating kanji. -It provides a way to convert stroke data from [KanjiVG][kanjivg] into kanji animations. +This library is a port of [Kanimaji][kanimaji], a library for animating kanji strokes. +It uses the stroke data from the [KanjiVG][kanjivg] project, and renders them as either SVG animations or flutter animations. -This library ports this ability into flutter, and lets you choose speed, colors, and formats, in the form of a `Kanimaji` widget and a SVG/GIF generating function. - -## Getting started - -Start by adding the project to your pubspec.yaml. +You can configure the animation's speed, curve, colors, and more. ## Usage TODO: Include short and useful examples for package users. Add longer examples -to `/example` folder. - -```dart -const like = 'sample'; -``` - -## Additional information - -The [svg library used](lib/svg) is mostly a rewrite of pythons [svg.path][svg.path]. -This is what kanimaji originally used for animation, and even thought there's a lot of svg path parsers in dart, I found none that was able to calculate the length of the path. If you do find one, please let me know! - -Also, do note that most of the comments in the project is brought over from the python projects. -I've tried to adjust and remove some of them to make them more useful, but they shouldn't be trusted if there's doubt. - -[svg.path]: https://pypi.org/project/svg.path/ \ No newline at end of file +to `/example` folder. diff --git a/lib/svg/parser.dart b/lib/svg/parser.dart index d24002a..f1e1e14 100644 --- a/lib/svg/parser.dart +++ b/lib/svg/parser.dart @@ -1,4 +1,6 @@ /// SVG Path specification parser +/// +/// See https://pypi.org/project/svg.path/ for the original implementation. import '../common/point.dart'; import 'path.dart';