From 84ca2e30d4e061049026ec677d4b0f2521065ed9 Mon Sep 17 00:00:00 2001 From: Li Junchen Date: Wed, 18 Sep 2024 16:41:31 +0800 Subject: [PATCH 1/2] docs: update README.md --- README.md | 56 ++++++++++++------------------------------------------- 1 file changed, 12 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index e8134b2f..bcd2f669 100644 --- a/README.md +++ b/README.md @@ -5,52 +5,20 @@ The build system and package manager for MoonBit. -```bash -$ moon help -The build system and package manager for MoonBit. +[Documentation](https://moonbitlang.github.io/moon/) | [中文文档](https://moonbitlang.github.io/moon/zh/) -Usage: moon [OPTIONS] - -Commands: - new Create a new MoonBit module - build Build the current package - check Check the current package, but don't build object files - run Run a main package - test Test the current package - clean Remove the target directory - fmt Format source code - doc Generate documentation - info Generate public interface (`.mbti`) files for all packages in the module - add Add a dependency - remove Remove a dependency - install Install dependencies - tree Display the dependency tree - login Log in to your account - register Register an account at mooncakes.io - publish Publish the current package - update Update the package registry index - coverage Code coverage utilities - generate-build-matrix Generate build matrix for benchmarking (legacy feature) - upgrade Upgrade toolchains - shell-completion Generate shell completion for bash/elvish/fish/pwsh/zsh to stdout - version Print version information and exit - help Print this message or the help of the given subcommand(s) - -Options: - -h, --help Print help - -Common Options: - -C, --directory The source code directory. Defaults to the current directory - --target-dir The target directory. Defaults to `source_dir/target` - -q, --quiet Suppress output - -v, --verbose Increase verbosity - --trace Trace the execution of the program - --dry-run Do not actually run the command - --build-graph Generate build graph -``` +## Installation + +Visit [https://www.moonbitlang.com/download/](https://www.moonbitlang.com/download/) to download the installer for your operating system. -See tutorials at -[MoonBit's Build System Tutorial](https://moonbitlang.github.io/moon/tutorial.html) +## Quickstart + +```bash +$ moon new hello +$ cd hello +$ moon run src/main +Hello, world! +``` ## Contributing From 53c9212e85db6bd54ea78916203b7e4ad8b0be90 Mon Sep 17 00:00:00 2001 From: Li Junchen Date: Wed, 18 Sep 2024 16:49:29 +0800 Subject: [PATCH 2/2] docs: remove help message in tutorial --- docs/manual-zh/src/tutorial.md | 41 +--------------------------------- docs/manual/src/tutorial.md | 41 +--------------------------------- 2 files changed, 2 insertions(+), 80 deletions(-) diff --git a/docs/manual-zh/src/tutorial.md b/docs/manual-zh/src/tutorial.md index a3285a8c..7ffc1cc5 100644 --- a/docs/manual-zh/src/tutorial.md +++ b/docs/manual-zh/src/tutorial.md @@ -12,46 +12,7 @@ ```bash $ moon help - The build system and package manager for MoonBit. - - Usage: moon [OPTIONS] - - Commands: - new Create a new MoonBit module - build Build the current package - check Check the current package, but don't build object files - run Run a main package - test Test the current package - clean Remove the target directory - fmt Format source code - doc Generate documentation - info Generate public interface (`.mbti`) files for all packages in the module - add Add a dependency - remove Remove a dependency - install Install dependencies - tree Display the dependency tree - login Log in to your account - register Register an account at mooncakes.io - publish Publish the current package - update Update the package registry index - coverage Code coverage utilities - generate-build-matrix Generate build matrix for benchmarking (legacy feature) - upgrade Upgrade toolchains - shell-completion Generate shell completion for bash/elvish/fish/pwsh/zsh to stdout - version Print version information and exit - help Print this message or the help of the given subcommand(s) - - Options: - -h, --help Print help - - Common Options: - -C, --directory The source code directory. Defaults to the current directory - --target-dir The target directory. Defaults to `source_dir/target` - -q, --quiet Suppress output - -v, --verbose Increase verbosity - --trace Trace the execution of the program - --dry-run Do not actually run the command - --build-graph Generate build graph + ... ``` 2. **Moonbit Language** Visual Studio Code 插件: 可以从 VS Code 市场安装。该插件为 MoonBit 提供了丰富的开发环境，包括语法高亮、代码补全、交互式除错和测试等功能。 diff --git a/docs/manual/src/tutorial.md b/docs/manual/src/tutorial.md index 1e496815..104b85fb 100644 --- a/docs/manual/src/tutorial.md +++ b/docs/manual/src/tutorial.md @@ -12,46 +12,7 @@ Before you begin with this tutorial, make sure you have installed the following: ```bash $ moon help - The build system and package manager for MoonBit. - - Usage: moon [OPTIONS] - - Commands: - new Create a new MoonBit module - build Build the current package - check Check the current package, but don't build object files - run Run a main package - test Test the current package - clean Remove the target directory - fmt Format source code - doc Generate documentation - info Generate public interface (`.mbti`) files for all packages in the module - add Add a dependency - remove Remove a dependency - install Install dependencies - tree Display the dependency tree - login Log in to your account - register Register an account at mooncakes.io - publish Publish the current package - update Update the package registry index - coverage Code coverage utilities - generate-build-matrix Generate build matrix for benchmarking (legacy feature) - upgrade Upgrade toolchains - shell-completion Generate shell completion for bash/elvish/fish/pwsh/zsh to stdout - version Print version information and exit - help Print this message or the help of the given subcommand(s) - - Options: - -h, --help Print help - - Common Options: - -C, --directory The source code directory. Defaults to the current directory - --target-dir The target directory. Defaults to `source_dir/target` - -q, --quiet Suppress output - -v, --verbose Increase verbosity - --trace Trace the execution of the program - --dry-run Do not actually run the command - --build-graph Generate build graph + ... ``` 2. **MoonBit Language** plugin in Visual Studio Code: You can install it from the VS Code marketplace. This plugin provides a rich development environment for MoonBit, including functionalities like syntax highlighting, code completion, and more.