Skip to content

Commit

Permalink
chore(doc): reuse commands doc from Milos in Makefile and cmd/README (#…
Browse files Browse the repository at this point in the history
…573)

Co-authored-by: Morgan <git@howl.moe>
Co-authored-by: grepsuzette <grepsuzette@users.noreply.github.com>
  • Loading branch information
3 people authored Mar 9, 2023
1 parent b5a664f commit 469b97a
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 6 deletions.
20 changes: 14 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
########################################
# 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
# gnotxport Importing/exporting transactions from local blockchain node storage
# website Serves gno website, along with user-defined content
# logos Intended to be used as a browser
#
# ---------------------- Developer commands -------------------
# gnoscan Dumps imports from specified file’s AST
# genproto Helper for generating .proto implementations
# gnofaucet Serves GNOT faucet
# gnodev Handy tool for developing gno packages & realms

# Dist suite
.PHONY: logos goscan gnoland gnokey gnofaucet logos reset gnoweb gnotxport
all: build
Expand All @@ -14,17 +27,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
Expand All @@ -37,7 +47,6 @@ install_gnodev:
@echo "Installing gnodev"
go install ./cmd/gnodev

# The faucet (daemon)
gnofaucet:
@echo "Building gnofaucet"
go build -o build/gnofaucet ./cmd/gnofaucet
Expand All @@ -56,7 +65,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
Expand Down
16 changes: 16 additions & 0 deletions cmd/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Short doc about the commands (please keep in sync with Makefile for now):

User commands:

* gnokey - key manipulation, also general interaction with gnoland
* gnoland - runs the blockchain node
* gnotxport - importing/exporting transactions from local blockchain node storage
* website - serves gno website, along with user-defined content
* logos - intended to be used as a browser

Developer commands:

* gnoscan - dumps imports from specified file’s AST
* genproto - helper for generating .proto implementations
* gnofaucet - serves GNOT faucet
* gnodev - handy tool for developing gno packages & realms

0 comments on commit 469b97a

Please sign in to comment.