Skip to content

Commit

Permalink
cmd/mecha: correct README install instructions
Browse files Browse the repository at this point in the history
Signed-off-by: deadprogram <[email protected]>
  • Loading branch information
deadprogram committed Mar 9, 2024
1 parent 2008d35 commit a4644a7
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions cmd/mecha/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,25 @@ See https://tinygo.org/getting-started/

In addition you need to install the `gonew` command:

```
```bash
go install golang.org/x/tools/cmd/gonew@latest
```

You can then install `mecha`:
Use `export GOPRIVATE` (only needed until the repo is public)

```bash
export GOPRIVATE=github.com/hybridgroup/mecha*
```

You can then install `mecha`:

```bash
go install github.com/hybridgroup/mechanoid/cmd/mecha@latest
```

## How to use

```
```bash
$ mecha
NAME:
mecha - Mechanoid CLI
Expand All @@ -33,13 +39,16 @@ USAGE:
mecha [global options] command [command options]

VERSION:
0.0.1
0.0.1-dev

COMMANDS:
new create a new Mechanoid project
build build a Mechanoid project to a binary file
flash flash a Mechanoid project to a device
test run tests for a Mechanoid project
new Create new Mechanoid project or module
build Build binary files for Mechanoid project
flash Flash Mechanoid project to hardware
run Run code for Mechanoid project
test Run tests for Mechanoid project
monitor Monitor connection to hardware using the serial port
about About Mechanoid
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
Expand All @@ -49,27 +58,27 @@ GLOBAL OPTIONS:

## New project

```
```bash
mecha new project example.com/myproject
```


## New project based on template

```
```bash
mecha new project -t=blink example.com/myproject
```

## New module

```
```bash
mecha new module mymodule

```

## New module based on template

```
```bash
mecha new module -t=blink mymodule

```

0 comments on commit a4644a7

Please sign in to comment.