Skip to content

Commit

Permalink
docs: update some infos
Browse files Browse the repository at this point in the history
Signed-off-by: Xunzhuo <[email protected]>
  • Loading branch information
Xunzhuo committed Apr 29, 2022
1 parent 246eba7 commit eec4110
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
11 changes: 6 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
# A fast and efficient cloud native application runtime 🚀.
# Commands below are used in Development 💻 and GitHub workflow 🌊.

# Usage: make <TARGETS> <OPTIONS> ...
# Usage: make <COMMANDS> <ARGS> ...

# Targets:
# COMMANDS:
# build Build layotto for host platform.
# build.multiarch Build layotto for multiple platforms. See option PLATFORMS.
# image Build docker images for host arch.
Expand All @@ -45,7 +45,7 @@
# all Run format codes, check codes, build Layotto codes for host platform with one command
# help Show this help info.

# Options:
# ARGS:
# BINS The binaries to build. Default is all of cmd.
# This option is available when using: make build/build.multiarch
# Example: make build BINS="layotto_multiple_api layotto"
Expand All @@ -57,6 +57,7 @@
# Example: make image.multiarch IMAGES="layotto" PLATFORMS="linux_amd64 linux_arm64"
# Supported Platforms: linux_amd64 linux_arm64 darwin_amd64 darwin_arm64


SHELL := /bin/bash

# ==============================================================================
Expand Down Expand Up @@ -250,7 +251,7 @@ all: format check.style check.unit check.lint build

define USAGE_OPTIONS

Options:
ARGS:
BINS The binaries to build. Default is all of cmd.
This option is available when using: make build/build.multiarch
Example: make build BINS="layotto_multiple_api layotto"
Expand All @@ -273,6 +274,6 @@ export USAGE_OPTIONS
help: Makefile
@echo -e "Layotto commands 👀: \n\nA fast and efficient cloud native application runtime 🚀."
@echo -e "Commands below are used in Development 💻 and GitHub workflow 🌊.\n"
@echo -e "Usage: make <TARGETS> <OPTIONS> ...\n\nTargets:"
@echo -e "Usage: make <COMMANDS> <ARGS> ...\n\nCOMMANDS:"
@sed -n 's/^##//p' $< | column -t -s ':' | sed -e 's/^/ /'
@echo "$$USAGE_OPTIONS"
6 changes: 3 additions & 3 deletions docs/en/development/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Layotto commands 👀:
A fast and efficient cloud native application runtime 🚀.
Commands below are used in Development 💻 and GitHub workflow 🌊.
Usage: make <TARGETS> <OPTIONS> ...
Usage: make <COMMANDS> <ARGS> ...
Targets:
COMMANDS:
build Build layotto for host platform.
build.multiarch Build layotto for multiple platforms. See option PLATFORMS.
image Build docker images for host arch.
Expand All @@ -50,7 +50,7 @@ Targets:
all Run format codes, check codes, build Layotto codes for host platform with one command
help Show this help info.
Options:
ARGS:
BINS The binaries to build. Default is all of cmd.
This option is available when using: make build/build.multiarch
Example: make build BINS="layotto_multiple_api layotto"
Expand Down
6 changes: 3 additions & 3 deletions docs/zh/development/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Layotto commands 👀:
A fast and efficient cloud native application runtime 🚀.
Commands below are used in Development 💻 and GitHub workflow 🌊.
Usage: make <TARGETS> <OPTIONS> ...
Usage: make <COMMANDS> <ARGS> ...
Targets:
COMMANDS:
build Build layotto for host platform.
build.multiarch Build layotto for multiple platforms. See option PLATFORMS.
image Build docker images for host arch.
Expand All @@ -50,7 +50,7 @@ Targets:
all Run format codes, check codes, build Layotto codes for host platform with one command
help Show this help info.
Options:
ARGS:
BINS The binaries to build. Default is all of cmd.
This option is available when using: make build/build.multiarch
Example: make build BINS="layotto_multiple_api layotto"
Expand Down

0 comments on commit eec4110

Please sign in to comment.