From f1d92a1be6d3cdef87b42be63af8d34c9fa773cb Mon Sep 17 00:00:00 2001 From: grepsuzette Date: Wed, 8 Mar 2023 14:43:07 +0800 Subject: [PATCH 1/5] chore(doc): reuse commands doc from Milos in Makefile and cmd/README --- Makefile | 19 +++++++++++++------ cmd/README | 16 ++++++++++++++++ 2 files changed, 29 insertions(+), 6 deletions(-) create mode 100644 cmd/README diff --git a/Makefile b/Makefile index 5f3b8727143..07bf5773dc3 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,16 @@ -######################################## +# ------------------------ User commands ----------------------- +# gnokey Key manipulation, also general interaction with gnoland +# gnoland Run the blockchain node +# gnotxport Importing/exporting transactions from local blockchain node storage +# website Serve gno website, along with user-defined content +# logos Intended to be used as a browser +# +# ---------------------- Developer commands ------------------- +# gnoscan Dump imports from specified file’s AST +# genproto Helper for generating .proto implementations +# gnofaucet Serve GNOT faucet +# gnodev Handy tool for developing gno packages & realms + # Dist suite .PHONY: logos goscan gnoland gnokey gnofaucet logos reset gnoweb gnotxport all: build @@ -14,17 +26,14 @@ reset: tools: go build -o build/logjack ./pkgs/autofile/cmd -# The main show (daemon) gnoland: @echo "Building gnoland" go build -o build/gnoland ./cmd/gnoland -# The main show (client) gnokey: @echo "Building gnokey" go build -o build/gnokey ./cmd/gnokey -# Development tool gnodev: @echo "Building gnodev" go build -o build/gnodev ./cmd/gnodev @@ -37,7 +46,6 @@ install_gnodev: @echo "Installing gnodev" go install ./cmd/gnodev -# The faucet (daemon) gnofaucet: @echo "Building gnofaucet" go build -o build/gnofaucet ./cmd/gnofaucet @@ -56,7 +64,6 @@ gnotxport: @echo "Building gnotxport" go build -o build/gnotxport ./cmd/gnotxport -# Logos is the interface to Gnoland logos: @echo "building logos" go build -o build/logos ./misc/logos/cmd/logos.go diff --git a/cmd/README b/cmd/README new file mode 100644 index 00000000000..2a0080a3d44 --- /dev/null +++ b/cmd/README @@ -0,0 +1,16 @@ +# Commands + +User commands: + +* gnokey - key manipulation, also general interaction with gnoland +* gnoland - run the blockchain node +* gnotxport - importing/exporting transactions from local blockchain node storage +* website - serve gno website, along with user-defined content +* logos - intended to be used as a browser + +Developer commands: + +* gnoscan - dump imports from specified file’s AST +* genproto - helper for generating .proto implementations +* gnofaucet - serve GNOT faucet +* gnodev - handy tool for developing gno packages & realms From 5b5e339eac06a2fe0f4c45043ddc63f9cac57c20 Mon Sep 17 00:00:00 2001 From: grepsuzette Date: Wed, 8 Mar 2023 22:42:18 +0800 Subject: [PATCH 2/5] use continuous tense --- Makefile | 8 ++++---- cmd/README | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index 07bf5773dc3..979b30cb9e3 100644 --- a/Makefile +++ b/Makefile @@ -1,14 +1,14 @@ # ------------------------ User commands ----------------------- # gnokey Key manipulation, also general interaction with gnoland -# gnoland Run the blockchain node +# gnoland Runs the blockchain node # gnotxport Importing/exporting transactions from local blockchain node storage -# website Serve gno website, along with user-defined content +# website Serves gno website, along with user-defined content # logos Intended to be used as a browser # # ---------------------- Developer commands ------------------- -# gnoscan Dump imports from specified file’s AST +# gnoscan Dumps imports from specified file’s AST # genproto Helper for generating .proto implementations -# gnofaucet Serve GNOT faucet +# gnofaucet Serves GNOT faucet # gnodev Handy tool for developing gno packages & realms # Dist suite diff --git a/cmd/README b/cmd/README index 2a0080a3d44..626f1187fbd 100644 --- a/cmd/README +++ b/cmd/README @@ -3,14 +3,14 @@ User commands: * gnokey - key manipulation, also general interaction with gnoland -* gnoland - run the blockchain node +* gnoland - runs the blockchain node * gnotxport - importing/exporting transactions from local blockchain node storage -* website - serve gno website, along with user-defined content +* website - serves gno website, along with user-defined content * logos - intended to be used as a browser Developer commands: -* gnoscan - dump imports from specified file’s AST +* gnoscan - dumps imports from specified file’s AST * genproto - helper for generating .proto implementations -* gnofaucet - serve GNOT faucet +* gnofaucet - serves GNOT faucet * gnodev - handy tool for developing gno packages & realms From b060e73f657c968befa8e46f35d4fd5b2985f060 Mon Sep 17 00:00:00 2001 From: grepsuzette Date: Wed, 8 Mar 2023 23:42:04 +0800 Subject: [PATCH 3/5] popular demand :) --- Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/Makefile b/Makefile index 979b30cb9e3..c72a84200ec 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,4 @@ +# Short doc about the commands (please keep in sync with cmd/README for now): # ------------------------ User commands ----------------------- # gnokey Key manipulation, also general interaction with gnoland # gnoland Runs the blockchain node From 273a5a0097224825a1f6bf939b7515925b3ef1d7 Mon Sep 17 00:00:00 2001 From: grepsuzette Date: Wed, 8 Mar 2023 23:45:43 +0800 Subject: [PATCH 4/5] and second one --- cmd/README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/README b/cmd/README index 626f1187fbd..a69c2b77244 100644 --- a/cmd/README +++ b/cmd/README @@ -1,4 +1,4 @@ -# Commands +# Short doc about the commands (please keep in sync with cmd/README for now): User commands: From c356646c41840fa7eb5a88b3b12f1c0f5a22ca36 Mon Sep 17 00:00:00 2001 From: grepsuzette <350354+grepsuzette@users.noreply.github.com> Date: Thu, 9 Mar 2023 01:56:50 +0800 Subject: [PATCH 5/5] oops Co-authored-by: Morgan --- cmd/README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/README b/cmd/README index a69c2b77244..c2179577376 100644 --- a/cmd/README +++ b/cmd/README @@ -1,4 +1,4 @@ -# Short doc about the commands (please keep in sync with cmd/README for now): +# Short doc about the commands (please keep in sync with Makefile for now): User commands: