Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

A few tweaks to quick start guide to make it work #54

Merged
merged 3 commits into from
Jul 30, 2022
Merged

A few tweaks to quick start guide to make it work #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ab468b
Update quick-start.mdx
accordeiro Jul 29, 2022
03f81aa
Add wasm target installation instructions
accordeiro Jul 29, 2022
465508b
Remove setup instructions from quick-start
accordeiro Jul 30, 2022
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
8 changes: 4 additions & 4 deletions docs/getting-started/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ first Soroban contract.
Start by creating a new Rust library using the `cargo new` command.

```sh
cargo new --lib [project-name]
cargo new --lib first-project
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This originally said [project-name] but later on in the config the project is referenced as "first-project" .

It's not a big deal but it took me a minute to realize I had to find and replace all first-project instances with the name I came up with for my test project.

If we make this change the whole page can be followed as a tutorial. I think anyone can figure this name can be replaced with whatever they want.

```

Open the `Cargo.toml`, it should look something like this:
Expand Down Expand Up @@ -149,9 +149,9 @@ WASM using it.

```sh
soroban-cli invoke \
--file target/wasm32-unknown-unknown/release/first-project.wasm \
--contract-id 1
--fn hello
--wasm target/wasm32-unknown-unknown/release/first-project.wasm \
--id 1 \
--fn hello \
Comment on lines +152 to +154
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops. Thank you!

--arg friend
```

Expand Down
9 changes: 9 additions & 0 deletions docs/getting-started/setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
If you use Windows, or need an alternative method of installing Rust, check out:
https://www.rust-lang.org/tools/install


## Install WASM target platform

You'll need to install the `wasm32-unknown-unknown` target platform in your machine:

```sh
rustup target add wasm32-unknown-unknown
```

## Configure an Editor

Many editors have support for Rust. Visit the following link to find out how to
Expand Down