Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak readme and docs #314

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Tweak readme and docs #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84ca2e3
docs: update README.md
lijunchen Sep 18, 2024
53c9212
docs: remove help message in tutorial
lijunchen Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 12 additions & 44 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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] <COMMAND>

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 <SOURCE_DIR> The source code directory. Defaults to the current directory
--target-dir <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

Expand Down
41 changes: 1 addition & 40 deletions docs/manual-zh/src/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,46 +12,7 @@

```bash
$ moon help
The build system and package manager for MoonBit.

Usage: moon [OPTIONS] <COMMAND>

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 <SOURCE_DIR> The source code directory. Defaults to the current directory
--target-dir <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 提供了丰富的开发环境，包括语法高亮、代码补全、交互式除错和测试等功能。
Expand Down
41 changes: 1 addition & 40 deletions docs/manual/src/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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] <COMMAND>

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 <SOURCE_DIR> The source code directory. Defaults to the current directory
--target-dir <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.
Expand Down