Skip to content

Commit

Permalink
chore: update installation instructions (#3944)
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt authored Feb 5, 2024
1 parent de59b4d commit 21f4352
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 16 deletions.
4 changes: 2 additions & 2 deletions .gitpod/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@ The latest `ignite` binary is downloaded from the project repo and installed in

## Stay in touch

Ignite CLI is a free and open source product maintained by [Ignite](https://ignite.com). Follow us on [Twitter](https://twitter.com/ignite_dev) to get the latest updates.
Ignite CLI is a free and open source product maintained by [Ignite](https://ignite.com). Follow us on [Twitter](https://twitter.com/ignite) to get the latest updates.

## Community

Ignite CLI is a free and open source product maintained by [Ignite](https://ignite.com). Here's where you can find us. Stay in touch.

* [ignite.com website](https://ignite.com)
* [@ignite_dev on Twitter](https://twitter.com/ignite_dev)
* [@ignite on Twitter](https://twitter.com/ignite)
* [ignite.com/blog](https://ignite.com/blog)
* [Ignite Discord](https://discord.gg/ignite)
* [Ignite YouTube](https://www.youtube.com/@ignitehq)
Expand Down
9 changes: 9 additions & 0 deletions docs/docs/01-welcome/02-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ installation. The `ignite` binary is installed in `/usr/local/bin`.
To learn more or customize the installation process, see the [installer docs](https://github.com/ignite/installer) on
GitHub.

:::tip
Alternatively, you can install Ignite CLI using a package manager on GNU/Linux:

```bash
snap install ignite --classic
```

:::

### Write permission

Ignite CLI installation requires write permission to the `/usr/local/bin/` directory. If the installation fails because
Expand Down
49 changes: 35 additions & 14 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,29 +40,50 @@ so you can focus on writing business logic.
### Installation

You can install Ignite with one simple command:
```

```sh
curl https://get.ignite.com/cli! | bash
```

If Ignite doesn't automatically move to your `/usr/local/bin` directory, use this command to do so:
Or using a package manager on GNU/Linux:

```sh
snap install ignite --classic
```

<!--
or macOS:
```sh
brew install ignite
```
-->

<details>
<summary>Troubleshoot</summary>

If Ignite doesn't automatically move to your `/usr/local/bin` directory, use this command to do so:

```sh
sudo mv ignite /usr/local/bin
```

If you encounter an error, you might need to create the `/usr/local/bin` directory and set the necessary permissions as follows:
```

```sh
mkdir /usr/local/bin
sudo chown -R $(whoami) /usr/local/bin
```

</details>

For more options on installing and using Ignite, please see the following:

Open Ignite CLI [in your web
browser](https://gitpod.io/#https://github.com/ignite/cli/tree/v0.25.2) (or open
[nightly version](https://gitpod.io/#https://github.com/ignite/cli)), or
[install the latest release](https://docs.ignite.com/welcome/install).
Open Ignite CLI [in your web browser](https://gitpod.io/#https://github.com/ignite/cli/tree/v28.1.1) (or open [nightly version](https://gitpod.io/#https://github.com/ignite/cli)), or [install the latest release](https://docs.ignite.com/welcome/install).

To create and start a blockchain:

```
```sh
ignite scaffold chain mars

cd mars
Expand Down Expand Up @@ -99,7 +120,7 @@ otherwise, a row refers to a minor version and all associated patch versions.

| Ignite CLI | Cosmos SDK | IBC | Notes |
|-------------|-------------|----------------------|---------------------------------------------------------------|
| v28.x.x | v0.50.x | v8.0.0 | - |
| v28.x.y | v0.50.x | v8.0.0 | - |
| v0.27.1 | v0.47.3 | v7.1.0 | - |
| v0.26.0 | v0.46.7 | v6.1.0 | - |
| v0.25.2 | v0.46.6 | v5.1.0 | Bump Tendermint version to v0.34.24 |
Expand All @@ -121,7 +142,7 @@ To upgrade your blockchain to the newer version of Cosmos SDK, see the
Ignite CLI commands can be extended using plugins. A plugin is a program that
uses github.com/hashicorp/go-plugin to communicate with the ignite binary.

#### Use a plugin
### Use a plugin

Plugins must be declared in the `config.yml` file, using the following syntax:

Expand Down Expand Up @@ -151,9 +172,9 @@ A plugin must implement `plugin.Interface`.
The easiest way to make a plugin is to use the `ignite plugin scaffold` command.
For example:

```
$ cd /home/user/src
$ ignite plugin scaffold github.com/foo/bar
```sh
cd /home/user/src
ignite plugin scaffold github.com/foo/bar
```

It will create a folder `bar` under `/home/user/src` and generate predefined
Expand Down Expand Up @@ -198,7 +219,7 @@ Ignite CLI is a free and open source product maintained by
[Ignite](https://ignite.com). Here's where you can find us. Stay in touch.

* [ignite.com website](https://ignite.com)
* [@ignite\_dev on Twitter](https://twitter.com/ignite_dev)
* [@ignite on Twitter](https://twitter.com/ignite)
* [ignite.com/blog](https://ignite.com/blog)
* [Ignite Discord](https://discord.com/invite/ignite)
* [Ignite YouTube](https://www.youtube.com/@ignitehq)
Expand Down

0 comments on commit 21f4352

Please sign in to comment.