Skip to content

Commit 4007e71

Browse files
committed
update getting started
1 parent 2d38bf0 commit 4007e71

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/getting_started.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
# Installing omnipackage-agent
1+
# Getting started
22

3-
Agent is responsible for building packages. You'll need it to build packages locally.
3+
## Installing omnipackage-agent
44

5-
## Multiple ways to install it
5+
Agent is responsible for building packages. You'll need it to build packages locally. There are multiple ways to install it:
66

7-
1. OmniPackage repositories [web.omnipackage.org/oleg/omnipackage-agent](https://web.omnipackage.org/oleg/omnipackage-agent).
8-
2. [Source code](https://github.com/omnipackage/omnipackage-agent-ruby). Reasonable recent version of Ruby is required, as well as docker or podman. Executables located in `exe/` directory.
9-
10-
## Test your installation
7+
1. OmniPackage repositories [web.omnipackage.org/oleg/omnipackage-agent](https://web.omnipackage.org/oleg/omnipackage-agent)
8+
2. [Source code](https://github.com/omnipackage/omnipackage-agent-ruby). Reasonably recent version of Ruby required. Executables located in `exe/` directory
119

10+
Test your installation
1211
```shell
13-
omnipackage --version
12+
omnipackage --check
1413
```
14+
15+
Agent requires `podman` or `docker` as well as few other common Linux programs. It will check their availability upon start and report if anything is missing.

0 commit comments

Comments
 (0)