From f49f72e048eb1bfed7b5fdbd210374cc232b916e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Calder=C3=B3n=20D=C3=ADaz?= <66186331+danielcdz@users.noreply.github.com> Date: Mon, 23 Sep 2024 11:59:19 -0600 Subject: [PATCH] Update README.md --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index d6c50ac..82278c1 100755 --- a/README.md +++ b/README.md @@ -16,42 +16,42 @@ [tg-badge]: https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&style=flat-square&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fdojoengine [tg-url]: https://t.me/dojoengine -# Byte Beasts: Official Guide +# Byte Beasts: Official Guide ๐Ÿ‰๐ŸŽฎ The official Byte Beasts guide, the quickest and most streamlined way to get your Dojo provable game up and running. This guide will assist you with the initial setup, from cloning the repository to deploying your world. Read the full tutorial [here](https://book.dojoengine.org/tutorial/dojo-starter). -## Prerequisites +## Prerequisites ๐Ÿ“‹ To be able to run the ByteBeasts backend you need to have Git, Rust and Scarb installed on your PC to satisfy Dojo dependencies. You can install them with the following steps: -### Install Rust +### Install Rust ๐Ÿฆ€ Go to the [Rust installation page](https://doc.rust-lang.org/book/ch01-01-installation.html#installing-rustup-on-linux-or-macos) After installing Rust, ensure your `PATH` environment variable includes the Cargo bin directory (usually `$HOME/.cargo/bin`). -### Install Git +### Install Git ๐Ÿง‘โ€๐Ÿ’ป Go to the [Git installation page](https://git-scm.com/downloads) and follow the instructions for your operating system to install Git. -### Install Scarb +### Install Scarb โš™๏ธ The Dojo toolchain integrates [Scarb](https://docs.swmansion.com/scarb/) to build and run Dojo projects, installation instructions are [here](https://docs.swmansion.com/scarb/download.html). -### Install Dojo using `dojoup` +### Install Dojo using `dojoup` ๐Ÿฅ‹ You can install with the `dojoup` version manager which enables you to easily install, update and manage your Dojo installation. -### Install dojoup +### Install dojoup ๐Ÿ› ๏ธ ```bash curl -L https://install.dojoengine.org | bash ``` -### Install the latest Dojo release +### Install the latest Dojo release ๐Ÿš€ ```bash dojoup ``` -### Install Dojo using `asdf` +### Install Dojo using `asdf` ๐Ÿ“ฆ You can alternatively use the `asdf` package manager to install and manage your Dojo installation. @@ -59,13 +59,13 @@ You can alternatively use the `asdf` package manager to install and manage your Follow the [asdf installation instructions](https://asdf-vm.com/guide/getting-started.html) -### Add the asdf-dojo plugin +### Add the asdf-dojo plugin ๐Ÿ”Œ ```bash asdf plugin add dojo https://github.com/dojoengine/asdf-dojo ``` -### Install the latest or a specific version +### Install the latest or a specific version ๐Ÿ†• ```bash asdf install dojo latest # For the latest version @@ -73,7 +73,7 @@ asdf install dojo 0.7.0 # For a specific version ``` -### Set the global or local version +### Set the global or local version ๐Ÿ“ ```bash asdf global dojo latest # Set globally @@ -81,15 +81,15 @@ asdf local dojo 0.7.0 # Set locally in your project directory ``` -## Running Locally +## Running Locally ๐Ÿ–ฅ๏ธ -### Terminal one (Make sure this is running) +### Terminal one (Make sure this is running) ๐Ÿƒ ```bash # Run Katana katana --disable-fee --allowed-origins "*" ``` -### Terminal two +### Terminal two ๐Ÿ”„ ```bash # Build the example sozo build @@ -101,12 +101,12 @@ sozo migrate apply torii --world 0x70835f8344647b1e573fe7aeccbf044230089eb19624d3c7dea4080f5dcb025 --allowed-origins "*" ``` -## Contribution +## Contribution ๐Ÿค We welcome contributions from developers of all levels! If you're interested in contributing to this project, please follow our [CONTRIBUTION GUIDELINES](./CONTRIBUTION.md) to get started. Whether it's fixing bugs, improving documentation, or adding new features, your help is greatly appreciated. Don't hesitate to ask questions or reach out for supportโ€”we're here to help! -## Communication channel +## Communication channel ๐Ÿ“ข If you're a contributor or would like to connect with the project maintainers, feel free to join our [Telegram](https://t.me/+-84e2pqLtqNkZDAx) group!