this repo has no description
Add section to README
authored by
Jacob Sandlund
and committed by
Tim Culverhouse
ac8ea11b
fc908c75
+35
+35
README.md
+35
README.md
···
88
88
// install exe below
89
89
```
90
90
91
+
#### Sharing `uucode` with your application
92
+
93
+
By default, libvaxis pulls in [`uucode`](https://github.com/jacobsandlund/uucode)
94
+
with a fixed set of fields it needs (`east_asian_width`, `grapheme_break`,
95
+
`general_category`, `is_emoji_presentation`). If your application also uses
96
+
`uucode` and needs additional fields, you can build libvaxis against your own
97
+
`uucode` module so that everyone shares one table.
98
+
99
+
Pass `.external_uucode = true` to the libvaxis dependency and wire your
100
+
`uucode` module into the `vaxis` module yourself:
101
+
102
+
```zig
103
+
const uucode = b.dependency("uucode", .{
104
+
.target = target,
105
+
.optimize = optimize,
106
+
.fields = @as([]const []const u8, &.{
107
+
// Add any fields your application needs, plus the fields libvaxis
108
+
// requires. The compiler will tell you which fields are missing
109
+
// (you only need the libvaxis fields for the parts of libvaxis you
110
+
// actually use). See `build.zig` in libvaxis for the full set it
111
+
// uses internally.
112
+
}),
113
+
});
114
+
115
+
const vaxis = b.dependency("vaxis", .{
116
+
.target = target,
117
+
.optimize = optimize,
118
+
.external_uucode = true,
119
+
});
120
+
vaxis.module("vaxis").addImport("uucode", uucode.module("uucode"));
121
+
122
+
exe.root_module.addImport("vaxis", vaxis.module("vaxis"));
123
+
exe.root_module.addImport("uucode", uucode.module("uucode"));
124
+
```
125
+
91
126
### vxfw (Vaxis framework)
92
127
93
128
Let's build a simple button counter application. This example can be run using