mach/dev/template/README.md
Stephen Gutekanst cb156a46d6 dev: template: fix broken link
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
2023-01-22 14:58:09 -07:00

38 lines
1.3 KiB
Markdown

# mach/foobar - a project template
This repository is a separate copy of the same library in the [main Mach repository](https://github.com/hexops/mach), and is automatically kept in sync, so that anyone can use this library in their own project if they like!
## Getting started
### Adding dependency
In a `libs` subdirectory of the root of your project:
```sh
git clone https://github.com/hexops/mach-foobar
```
Then in your `build.zig` add:
```zig
...
const foobar = @import("libs/mach-foobar/build.zig");
pub fn build(b: *Builder) void {
...
exe.addPackage(foobar.pkg);
foobar.link(b, exe, .{});
}
```
## Join the community
Join the Mach community [on Discord](https://discord.gg/XNG3NZgCqp) or [Matrix](https://matrix.to/#/#hexops:matrix.org) to discuss this project, ask questions, get help, etc.
## Issues
Issues are tracked in the [main Mach repository](https://github.com/hexops/mach/issues?q=is%3Aissue+is%3Aopen+label%3Afoobar).
## Contributing
Contributions are very welcome. Pull requests must be sent to [the main repository](https://github.com/hexops/mach/tree/main/libs/foobar) to avoid some complex merge conflicts we'd get by accepting contributions in both repositories. Once the changes are merged there, they'll get sync'd to this repository automatically.