From 8c41b872fd7752a168e5bf5e4cacf5e87acf82b8 Mon Sep 17 00:00:00 2001 From: Tristan Isham Date: Mon, 29 Jan 2024 22:41:55 -0500 Subject: [PATCH] added warning to docs --- README.md | 3 +++ help.txt | 2 ++ main.go | 1 + 3 files changed, 6 insertions(+) diff --git a/README.md b/README.md index 8e5b6d3..ab08389 100644 --- a/README.md +++ b/README.md @@ -199,6 +199,9 @@ zvm help ```sh -color # Turn ANSI color printing on or off for ZVM's output, i.e. -color=true +``` +### BETA FLAGS: (Might not work as expected) +```sh -vmu # Changes the version map url (good if you host your own Zig distrobution server). # ZVM expects properly formatted URLs with the included protocol. # URLs that don't serve workable JSON files will break ZVM. If you ever want to reset diff --git a/help.txt b/help.txt index 2b82f07..d90cf21 100644 --- a/help.txt +++ b/help.txt @@ -32,6 +32,8 @@ help ------------- Flags ----------------- -color= | Turn color printing on or off for ZVM's output +BETA FLAGS: (Might not work as expected) + -vmu | Changes the version map url (Good if you host your own Zig distrobution server) URLs that don't serve workable JSON files will break ZVM. If you ever want to reset your version map url, just run -vmu default. diff --git a/main.go b/main.go index e77f413..ecea4ba 100644 --- a/main.go +++ b/main.go @@ -48,6 +48,7 @@ func main() { flag.Parse() if sVersionMapUrl != nil { + log.Warn("this is a beta flag, and may not behave as expected.") if *sVersionMapUrl == "default" { if err := zvm.Settings.ResetVersionMap(); err != nil { log.Fatal(err)