TennesseeTrash/kanjivg-tools
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update the README with current API

Browse source
This commit is contained in:
TennesseeTrash 2025-06-16 20:33:47 +02:00
parent 0c0a8e346c
commit 838d3dcdfe
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -21,6 +21,12 @@ void AnimateFile(const Path& source, const Path& destination,
std::string Animate(const std::string& source,
const AnimationSettings& settings = AnimationSettings::Default());
void RemoveStrokeNumbers(const std::string& source, const std::string& destination,
const RemovalSetttings& settings = RemovalSetttings::Default());
std::string RemoveStrokeNumbers(const std::string& source,
const RemovalSetttings& settings = RemovalSetttings::Default());
```
The former function takes in two paths, where the first one specifies the file to be read, and
@ -113,7 +119,7 @@ Some caveats:
The default settings generate a table with no characters (and horrible styling), you will need to
specify custom settings like this for actual use:
```cpp
auto doc = GeneratePage({
auto doc = GeneratePage(std::vector<CharacterInfo>(), {
.FullDocument = Flag::Enable,
.OverrideIndentLevel = Flag::Disable,
.IndentLevel = 0,