Skip to content

Commit

Permalink
Merge pull request #60 from Vimal-Kumar-V/readme
Browse files Browse the repository at this point in the history
📝 Steps to setup orca in local is updated
  • Loading branch information
itsparser authored Feb 25, 2024
2 parents ef8f2b0 + 63ab581 commit 22e1d8f
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,12 @@ Orca follows the Contributor Covenant Code of Conduct. See [CODE\_OF\_CONDUCT.md
## **Installation**

1. Install the Rust compiler and toolchain following the instructions at [https://www.rust-lang.org/](https://www.rust-lang.org/)
2. Clone the Orca repository: **git clone https://github.com/[username]/orca.git**
3. Change into the Orca directory: **cd orca**
4. Build and run Orca: **cargo run**
2. Install docker in your system following the instructions at [https://docs.docker.com/get-docker/]
3. Go to this repo [https://github.com/orcaci/orca] and fork this repository
4. Clone the Orca repository: ```git clone https://github.com/[username]/orca.git```
5. Change into the Orca directory: ```cd orca```
6. Copy the config file ```cp .cargo/config.local.toml .cargo/config.toml``` or Create a new file named **cargo.toml** under .cargo/ directory and add your own secrets
7. Now run start.sh file to start orca. ```bash start.sh```

## **Usage**

Expand Down

0 comments on commit 22e1d8f

Please sign in to comment.