Skip to content

Commit

Permalink
Apply intro changes to master (#1729)
Browse files Browse the repository at this point in the history
* Update Intro.md

Added explanation on how to create the ```~/.aragon``` directory using ```aragon devchain``` command. It's not being automatically created by the ```npm install -g @aragon/cli``` as the guide states


Co-authored-by: paalex <[email protected]>
Co-authored-by: Brett Sun <[email protected]>
  • Loading branch information
3 people authored Jun 17, 2020
1 parent 73a7be3 commit d7111a8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/Intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The following must be installed prior to installation:
- Node + npm

- Version of Node we recommend to be [the latest LTS version, available to download here](https://nodejs.org/en/).
- After downloading and unpacking, you must add the /bin folder to you \$PATH.s
- After downloading and unpacking, you must add the /bin folder to you \$PATH.

For Linux:

Expand Down Expand Up @@ -57,7 +57,7 @@ After installing, the main `aragon` executable will be available for use. It wil

#### The ~/.aragon directory

The aragonCLI creates the `.aragon` directory under the user directory where it saves the state of the devchain and the [Aragon client](client.md).
The aragonCLI creates the `.aragon` directory under the user's home directory, where it saves the state of the devchain and the [Aragon client](client.md). At the moment, this folder is only automatically created after running `aragon devchain` once, but can also be created by via `mkdir ~/.aragon`.

In case the client is not loading properly, deleting the `~/.aragon` directory will make `aragon run` recreate the environment the next time it is used and may solve the issue.

Expand Down Expand Up @@ -87,7 +87,7 @@ You can also define an `~/.aragon/mnemonic.json` file like:

#### Install IPFS

Since `v6.0.0` we separate the instalation of `go-ipfs` from the aragonCLI. If you do not have it installed globally on your system we have a couple of comands to help with that:`aragon ipfs install` and `aragon ipfs uninstall`.
Since `v6.0.0` we separate the installation of `go-ipfs` from the aragonCLI. If you do not have it installed globally on your system we have a couple of commands to help with that:`aragon ipfs install` and `aragon ipfs uninstall`.

## Global options

Expand Down Expand Up @@ -122,7 +122,7 @@ npx create-aragon-app <app-name> [boilerplate]
- `boilerplate`: (optional) the Github repo name or alias for a boilerplate to set up your app. The currently available boilerplates are:
- `react`: this boilerplate contains a very basic Counter app and a webapp for interacting with it. It showcases the end-to-end interaction with an Aragon app, from the contracts to the webapp. Also comes with a DAO Template which will allow for using your app to interact with other Aragon apps like the Voting app. You can read more about DAO Template [here](templates-intro.md).
- `bare`: this boilerplate will just set up your app directory structure but contains no functional code.
- `tutorial`: this boilerplate is the one used in Your first Aragon app guide.
- `tutorial`: this boilerplate is the one used in the ["Your first Aragon app"](https://github.com/aragon/your-first-aragon-app) guide.

> **Note**<br>
> This is an independent package, it's not necessary to have `@aragon/cli` installed to use it.
Expand Down

0 comments on commit d7111a8

Please sign in to comment.