authorgravatar for hello@nektro.netMeghan Denny <hello@nektro.net> 2021-07-31 19:03:15 -07:00
committergravatar for hello@nektro.netMeghan Denny <hello@nektro.net> 2021-07-31 19:03:15 -07:00
logfb9c97be027e0d0d5fc714bcedc15dfbcb362d24
tree54cb58903bf54b86d7d4a35ce15128183c5552b4
parent369e69f06c2d734d8b444ef50868b0cbe0bc4d5a

docs- add first step in tutorial


1 files changed, 18 insertions(+), 0 deletions(-)

docs/tutorial.md created+18
...@@ -0,0 +1,18 @@
1# Zigmod Tutorial
2
3This guide will go over the various common workflows done while using Zigmod as well as how its design goals fit into them.
4
5## Initialize a new project
6To get started you'll want to run through these commands.
7
8```
9git init
10zig init-exe
11zigmod init
12```
13
14Zigmod'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.
15
16The wizard will also ask if you'd like it setup any additional metadata files such as `.gitignore` or `LICENSE` for you.
17
18> Ref: See [`zigmod init`](./commands/init.md) for more info.