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

Jump to bottom

Update getting-started.md #1108

Merged
merged 1 commit into from
Aug 11, 2023
Merged

Update getting-started.md #1108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 21 additions & 21 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# The default id is the same as the one being defined below. so not needed
# The default id is the same as the one defined below. so not needed
title: Getting Started
---

Expand Down Expand Up @@ -32,26 +32,26 @@ To install Clarinet, you may choose from the following:

### Install on macOS (Homebrew)

To install Clarinet using macOs, you must first have Homebrew installed on your system. If you do not already have Homebrew already installed,
please refer to the [Homebrew](https://brew.sh/)documentation for detailed information on how to install Homebrew.
To install Clarinet using macOs, you must first install Homebrew on your system. If you do not already have Homebrew already installed,
please refer to the [Homebrew](https://brew.sh/) documentation for detailed information on installing Homebrew.

Once you have Homebrew installed, run the following command shown below in your terminal.
Once you have Homebrew installed, run the below command in your terminal.

```bash
brew install clarinet
```

For more informaiton on how to install Clarinet on macOS, please see the [Setting Up Your Clarity Development Environment (Mac)](https://www.youtube.com/watch?v=dpPopuvYU90) video walkthrough.
For more information on how to install Clarinet on macOS, please see the [Setting Up Your Clarity Development Environment (Mac)](https://www.youtube.com/watch?v=dpPopuvYU90) video walkthrough.

### Install on Windows

The easiest way to install Clarinet on Windows is to use the MSI installer,
which you can download from the [Hiro releases page](https://github.com/hirosystems/clarinet/releases).

You may also install Clarinet on Winget. This is the package manager that Microsoft created, which includes in the latest Windows updates.
Simply enter the command below.
You may also install Clarinet on Winget. Microsoft created This package manager, which includes the latest Windows updates.
Enter the command below.

```powershell
```PowerShell
winget install clarinet
```

Expand All @@ -61,10 +61,10 @@ For more information on how to install Clarinet on Windows, please see the [Sett

If you would like to install Clarinet from pre-built binaries, you must first download the latest release from the
[Hiro releases page](https://github.com/hirosystems/clarinet/releases). When you have downloaded the latest release,
unzip the binary and then copy it to a location that is already in your path, such as `/usr/local/bin` using the command shwon below.
unzip the binary and copy it to a location already in your path, such as `/usr/local/bin`, using the command shown below.

```sh
# note: you can change the v0.27.0 with version that are available in the releases page.
# note: you can change the v0.27.0 version that is available on the releases page.
wget -nv https://github.com/hirosystems/clarinet/releases/download/v0.27.0/clarinet-linux-x64-glibc.tar.gz -O clarinet-linux-x64.tar.gz
tar -xf clarinet-linux-x64.tar.gz
chmod +x ./clarinet
Expand All @@ -73,16 +73,16 @@ mv ./clarinet /usr/local/bin

>**_NOTE:_**
>
>If you are using macOS, you may receive security errors when trying to run the pre-compiled binary.
>In order to resolve the security warning, use the command below and replace the path `/usr/local/bin/clarinet` with your local binary file.
>If you use macOS, you may receive security errors when running the pre-compiled binary.
> To resolve the security warning, use the command below and replace the path `/usr/local/bin/clarinet` with your local binary file.

```sh
xattr -d com.apple.quarantine /usr/local/bin/clarinet
```

### Install from source using Cargo

You may also install Clarinet using Cargo. If you choose this option, please be aware that you must first intall Rust.
You may also install Clarinet using Cargo. If you choose this option, please be aware that you must first install Rust.
For more information on installing Rust, please see the [Install Rust](https://www.rust-lang.org/tools/install) page for access
to `cargo`, the Rust package manager.

Expand All @@ -92,7 +92,7 @@ sudo apt install build-essential pkg-config libssl-dev
```
### Build Clarinet

Once you have installed Clarinet using Cargo, you can build Clarinet from source using Cargo with the following commands:
Once you have installed Clarinet using Cargo, you can build Clarinet from the source using Cargo with the following commands:

```bash
git clone https://github.com/hirosystems/clarinet.git --recursive
Expand All @@ -102,8 +102,8 @@ cargo clarinet-install

By default, you will be placed in our development branch, `develop`, with code that has not yet been released.

- If you plan to submit any changes to the code, then this is the right branch for you.
- If you would prefer to have the latest stable version, then switch to the main branch by entering the command below.
- If you plan to submit any code changes, this is the right branch for you.
- If you prefer the latest stable version, switch to the main branch by entering the command below.

```bash
git checkout main
Expand All @@ -116,17 +116,17 @@ git pull
git submodule update --recursive
```

Now that you have installed and built Clarinet, you can [create a new project](how-to-guides/how-to-create-new-project.md), and then [populate the project with smart contracts](how-to-guides/how-to-add-contract.md).
Now that you have installed and built Clarinet, you can [create a new project](how-to-guides/how-to-create-new-project.md) and then [populate the project with smart contracts](how-to-guides/how-to-add-contract.md).

Clarinet also provides tools for interacting with your contracts in a Read, Evaluate, Print, Loop (REPL) console, and perform automated [testing of contracts](how-to-guides/how-to-test-contract.md).
Clarinet also provides tools for interacting with your contracts in a Read, Evaluate, Print, Loop (REPL) console and perform automated [testing of contracts](how-to-guides/how-to-test-contract.md).

## Setup shell completions

Clarinet already has many different commands built in, therefore, you may find it useful to enable tab-completion in your shell.
You can use `clarinet` to generate the shell completion scripts for many common shells using the command shown below.
Clarinet already has many different commands built in. Therefore, enabling tab completion in your shell may be useful.
Using the command below, you can use `clarinet` to generate the shell completion scripts for many common shells.

```sh
clarinet completions (bash|elvish|fish|powershell|zsh)
```

After generating the file, you can refer to the documentation for your shell to determine where this file should be moved to, and what other steps may be necessary to enable tab-completion for `clarinet`.
After generating the file, you can refer to the documentation for your shell to determine where this file should be moved to and what other steps may be necessary to enable tab completion for `clarinet`.
Loading