Skip to content

Commit

Permalink
updated readme with instructions to use CLI script
Browse files Browse the repository at this point in the history
  • Loading branch information
Arief-AK committed May 27, 2024
1 parent d07d0d5 commit a432bdb
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,21 @@ Welcome to the Sarax project! Sarax aims to develop an open-source aerial manipu
- [QGroundControl](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html#ubuntu) is installed.

### Quickstart
#### Option 1:
A CLI application has been made to support the setup and installation of the framework.

![image](Docs/images/sarax_cli_application.png)

Run it with the following command.
Clone and run it with the following command.
```shell
sudo chmod +x scripts/run.sh && ./scripts/run.sh
git clone https://github.com/Arief-AK/sarax.git && sudo chmod +x scripts/run.sh && ./scripts/run.sh
```

#### Option 2:
### Setup software
> [!WARNING]\
> This assumes that all dependencies mentioned in the [Assumptions](#assumptions) are installed
Create the workspace, clone the necessary repositories, and build
```shell
mkdir -p sarax_ws/src && cd sarax_ws/ && catkin init && wstool init src
Expand Down

0 comments on commit a432bdb

Please sign in to comment.