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

Update the README to reflect Tablegen API changes

Browse source
This commit is contained in:
TennesseeTrash 2025-06-16 05:33:20 +02:00
parent 5cf55e09a4
commit c15045562e
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -78,14 +78,18 @@ This library generates a table of kanji images from a specified list with variou
values. It's made up of the following interface:
```cpp
std::string GeneratePage(const Settings& settings = Settings::Default());
std::string GeneratePage(const std::vector<CharacterInfo>& characters,
const Settings& settings = Settings::Default());
void GeneratePage(const std::string& path, const Settings& settings = Settings::Default());
void GeneratePage(const std::string& path, const std::vector<CharacterInfo>& characters,
const Settings& settings = Settings::Default());
#ifdef TABLEGEN_EXPOSE_XML
void GenerateAsChild(pugi::xml_node& node, const Settings& settings = Settings::Default());
void GenerateAsChild(pugi::xml_node& node, const std::vector<CharacterInfo>& characters,
const Settings& settings = Settings::Default());
pugi::xml_document GenerateDocument(const Settings& settings = Settings::Default());
pugi::xml_document GenerateDocument(const std::vector<CharacterInfo>& characters,
const Settings& settings = Settings::Default());
#endif
```
@ -126,9 +130,5 @@ auto doc = GeneratePage({
.CharactersPerRow = 3,
.ImageFormat = "http://the.url/where/you/have/images/{}.svg",
.AnimationFormat = "http://the.url/where/you/have/animations/{}.svg",
.Characters = {
/* The actual characters you want in the table, example: */
{ .Label = "Day", .ImagePath = "%E6%97%A5", .AnimationPath = "%E6%97%A5", },
},
});
```