From fb9c97be027e0d0d5fc714bcedc15dfbcb362d24 Mon Sep 17 00:00:00 2001 From: Meghan Denny Date: Sat, 31 Jul 2021 19:03:15 -0700 Subject: [PATCH] docs- add first step in tutorial --- docs/tutorial.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/tutorial.md diff --git a/docs/tutorial.md b/docs/tutorial.md new file mode 100644 index 0000000000000000000000000000000000000000..6503c12544d48cb7f287790343ca8e4e353719c0 --- /dev/null +++ b/docs/tutorial.md @@ -0,0 +1,18 @@ +# Zigmod Tutorial + +This guide will go over the various common workflows done while using Zigmod as well as how its design goals fit into them. + +## Initialize a new project +To get started you'll want to run through these commands. + +``` +git init +zig init-exe +zigmod init +``` + +Zigmod's init wizard will ask you if the current project is an application or a library and setup some initial properties in your `zig.mod`. However, if you do plan to have a project that is both a library to be used in other Zig projects and an application itself, don't fret. For Zigmod is able to support both of thses configurations simultaneously. + +The wizard will also ask if you'd like it setup any additional metadata files such as `.gitignore` or `LICENSE` for you. + +> Ref: See [`zigmod init`](./commands/init.md) for more info. -- 2.54.0