Skip to content

Commit

Permalink
rework the getting-started
Browse files Browse the repository at this point in the history
  • Loading branch information
ponderingdemocritus committed Aug 15, 2023
1 parent 51ff800 commit a5b33f2
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 32 deletions.
34 changes: 3 additions & 31 deletions src/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,37 +18,9 @@ which will make the `dojoup` command available in your CLI.
dojoup
```

`dojoup` will install the latest stable release, but you can install nightly dojo build with:
For full `dojoup` reference and debugging see [Dojoup](../toolchain/dojoup.md).

```sh
dojoup -v nightly
```

You can see a full list of commands with

```sh
dojoup -help
```

---

> Note: You may have to install `jq` to use `dojoup`. You can do so with the following commands:
```sh
# Debian
sudo apt-get install jq

# Mac
brew install jq
```

### Precompiled binaries

Precompiled binaries are available from the [GitHub releases page](https://github.com/dojoengine/dojo/releases).
These are better managed by using [Dojoup](#using-dojoup).
### Next steps

> Head to [Hello Dojo](../cairo/hello-dojo.md) to get create your first Dojo world.
> ℹ️ **Note**
>
> If you're on Windows, you will need to install and use [Git BASH](https://gitforwindows.org/) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install),
> as your terminal, since Dojoup currently does not support Powershell or Cmd.
22 changes: 21 additions & 1 deletion src/toolchain/dojoup.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ To install latest **stable** version:
```sh
dojoup
```
> Note: You may have to install `jq` to use `dojoup`. You can do so with the following commands:
```sh
# Debian
sudo apt-get install jq

# Mac
brew install jq
```

To install a specific **version** (in this case the `nightly` version):

Expand Down Expand Up @@ -64,4 +73,15 @@ dojoup --path ./git/dojo

**Tip**: All flags have a single character shorthand equivalent! You can use `-v` instead of `--version`, etc.

---
---

### Precompiled binaries

Precompiled binaries are available from the [GitHub releases page](https://github.com/dojoengine/dojo/releases).
These are better managed by using [Dojoup](#using-dojoup).


> ℹ️ **Note**
>
> If you're on Windows, you will need to install and use [Git BASH](https://gitforwindows.org/) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install),
> as your terminal, since Dojoup currently does not support Powershell or Cmd.

0 comments on commit a5b33f2

Please sign in to comment.