From 18f277cc64a9803f893e90eee1ba7a976e03eadb Mon Sep 17 00:00:00 2001 From: Meghan Denny Date: Sat, 21 Aug 2021 02:26:15 -0700 Subject: [PATCH] add direct link to tutorial in READMEs --- README.md | 2 ++ docs/README.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/README.md b/README.md index 00977c72a361b5efec60d4547ed3a02b4116de41..1a452b927fbb2cd885337faf41c71c784c33e789 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,8 @@ $ ./zig-out/bin/zigmod ## Usage Check out our [docs](docs/) or the website: https://nektro.github.io/zigmod/. +There is now also a tutorial-style getting started guide that goes over various use cases that Zigmod provides and caters to. It is [available here](docs/tutorial.md). + ## Prior Art - https://golang.org/ref/mod#go-mod-file - https://github.com/mattnite/zkg diff --git a/docs/README.md b/docs/README.md index 9e50da47ab60a4904e3c852f26d21f9db49c4ed0..d582e442ab5e050699bfec12fb4f1f0ae810e9bb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -40,6 +40,8 @@ Check here for the [`zig.mod` reference](./zig.mod.md). Check here for the [`deps.zig` reference](./deps.zig.md). +There is now also a tutorial-style guide that goes over various use cases that Zigmod provides and caters to. It is [available here](tutorial.md). + ### A new project Create a new directory for your project and run these commands to get started: ``` -- 2.54.0