11# zigverm
2- Version manager for the Zig Programming Language.
32
4- It lets you install and manage your Zig installation.
5-
6- ** zigverm is in early stages of its development, it can do [ basic things] ( #features ) and platform
7- support may not be on par with other version managers. If you encounter issues or want to request a
8- feature be sure to drop a issue on the GitHub issue tracker.**
3+ zigverm is a version manager for the [ Zig] ( https://ziglang.org ) programming Language. It lets you install Zig and further manage your installation.
94
105## Platform Support
11- Legend:
12- 🎉 - Binary releases + automatic installer available
13- 💪 - binary releases available
14- ❌ - No binary releases. Maybe supported later. Requires [ compiling] ( #compiling )
6+
7+ Legend:
8+ 🎉 - Binary releases + automatic installer available
9+ 💪 - binary releases available
10+ ❌ - No binary releases. Maybe supported later. Requires [ compiling] ( #compiling )
1511\- - Not applicable
1612
1713| OS/Arch | x86_64 | x86 | aarch64 | armv7a | riscv64 |
18- | --------- | -------- | ----- | --------- | -------- | --------- |
19- | Windows | 💪 | 💪 | ❌ | - | - |
20- | Linux | 🎉 | 🎉 | 🎉 | ❌ | ❌ |
21- | MacOS | 🎉 | - | 🎉 | - | - |
14+ | ------- | ------ | --- | ------- | ------ | ------- |
15+ | Windows | 💪 | 💪 | ❌ | - | - |
16+ | Linux | 🎉 | 🎉 | 🎉 | ❌ | ❌ |
17+ | MacOS | 🎉 | - | 🎉 | - | - |
2218
2319## Installation
24- ### For Linux and MacOS (x86_64+aarch64)
20+
21+ ### For Linux and MacOS (x86_64/aarch64)
22+
2523You can use this automated install script which will install zigverm along with the latest version of Zig
2624
2725``` sh
@@ -37,41 +35,50 @@ The script will also put the installation directory's `bin` folder to your `$PAT
3735this it will append a line to your ` $HOME/.profile ` and your shell's rc file. The file for each
3836shell supported is listed below:
3937
40- - Bash: ` $HOME/.bashrc `
38+ - Bash: ` $HOME/.bashrc `
4139- Zsh: ` $HOME/.zshrc `
4240- Fish: ` $XDG_CONFIG_HOME/fish/config.fish ` , if not set then uses ` $HOME/.config/fish/config.fish `
4341
4442### For Windows
45- * Create the following folder structure in ` C:\Users\[YOU-USERNAME]\.zigverm ` :
43+
44+ - Create the following folder structure in ` C:\Users\[YOU-USERNAME]\.zigverm ` :
45+
4646```
4747.
4848├── bin
4949├── downloads
5050└── installs
5151```
52- * Download the latest release for Windows from GitHub and extract it.
53- * Copy ` zigverm.exe ` and ` zig.exe ` to the ` bin/ ` folder.
54- * Ass the ` bin ` directory to your ` PATH ` enviroment variable
52+
53+ - Download the latest release for Windows from GitHub and extract it.
54+ - Copy ` zigverm.exe ` and ` zig.exe ` to the ` bin/ ` folder.
55+ - Ass the ` bin ` directory to your ` PATH ` enviroment variable
5556
5657### Compiling
57- Requirements:
58- - Zig >= 0.12.0
58+
59+ Requirements:
60+
61+ - Zig >= 0.12.0. Note that Zig master versions are not supported.
5962- libc on non-Windows systems. Can be provided by Zig itself, if available for the platform.
6063- ` git ` , if you want to compile the latest commit or you want to develop ` zigverm ` .
6164
6265Now to compile:
66+
6367- Clone the repo or download a source archive depending on if you want to compile the latest ` main `
64- branck or a release.
68+ branck or a release.
6569- Extract the archive and change into the extracted directory.
6670- Run the following command
71+
6772```
6873zig build --release=safe
6974```
75+
7076- If you are devloping ` zigverm ` , you can omit the ` --release=safe ` flag.
7177- You will have ` zigverm ` and ` zig ` in ` zig-out/bin/ ` directory
72- - Lastly follow the same steps [ for windows] ( #for-windows )
78+ - Lastly follow the same steps [ for windows] ( #for-windows )
7379
7480## Features
81+
7582- [x] Install versions (master, stable, x.y x.y.z)
7683- [x] Continue download if previously interrupted
7784- [x] Remove versions
@@ -82,7 +89,9 @@ zig build --release=safe
8289- [x] Tries to maintain strong compatiblity with the wider zig ecosystem (` zls ` , ` zig.vim ` )
8390
8491## Docs
92+
8593Read the [ quick guide] ( ./docs/quick-guide.md )
8694
8795## License
96+
8897` zigverm ` is licensed under the Apache License 2.0. See the [ LICENSE] ( ./LICENSE ) file.
0 commit comments