Skip to content

Commit

Permalink
doc: add quick start guide to README.md
Browse files Browse the repository at this point in the history
Updating README with quick start guide:
* DAO repository setup
* Display installation and running first app demo

Signed-off-by: Harman Kalra <hkalra@marvell.com>
Change-Id: Ie599e5eee38e1179b3874c5070eb02a19419d0a1
Reviewed-on: https://sj1git1.cavium.com/c/IP/SW/dataplane/dpu-offload/+/129170
Tested-by: Jerin Jacob <jerinj@marvell.com>
Reviewed-by: Jerin Jacob <jerinj@marvell.com>
  • Loading branch information
harman-kalra authored and jerinjacobk committed Jun 7, 2024
1 parent 21ed5c4 commit 1a40a5b
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,33 @@ https://marvellembeddedprocessors.github.io/dpu-accelerator-offload/guides/
## API Reference Guide

https://marvellembeddedprocessors.github.io/dpu-accelerator-offload/api/

## Quick start Guide

Update ubuntu repository to download dao packages

```sh

curl -fsSL https://uat.marvell.com/public/repo/octeon/dao/ubuntu/dao.gpg | sudo gpg --dearmor -o /etc/apt/keyrings/dao.gpg
curl -SsL -o /etc/apt/sources.list.d/dao.list https://uat.marvell.com/public/repo/octeon/dao/ubuntu/dao.list
sudo chmod 644 /etc/apt/sources.list.d/dao.list
sudo chmod 644 /etc/apt/keyrings/dao.gpg
apt-get update

```

Installing DAO package

```sh

apt-get install dao-cn10k-latest

```

Installation Demo

[<img src="doc/guides/_static/demo/install.png" style="width:400px;"/>](https://marvellembeddedprocessors.github.io/dpu-accelerator-offload/guides/gsg/install.html#installation-demo)

Running First DAO application

[<img src="doc/guides/_static/demo/run.png" style="width:400px;"/>](https://marvellembeddedprocessors.github.io/dpu-accelerator-offload/guides/applications/smart-nic.html#application-running-demo)
Binary file added doc/guides/_static/demo/install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/guides/_static/demo/run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1a40a5b

Please sign in to comment.