Skip to content

Commit bf17b22

Browse files
committed
up docs
1 parent 0419ad1 commit bf17b22

File tree

4 files changed

+14
-71
lines changed

4 files changed

+14
-71
lines changed

docs/about.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

docs/getting_started.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ omnipackage --check
1414

1515
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.
1616

17-
## Building example project
17+
## Building example project locally
1818

1919
1. Clone [examples]({{ examples_url }}) repository
2020
2. `cd examples`
@@ -24,3 +24,12 @@ Now you can install the resulting package. For example, Debian 12:
2424
```shell
2525
sudo dpkg -i /tmp/omnipackage-headless-build/omnipackage-example-c-debian_12/output/omnipackage-example-c_0.0.1-0_amd64.deb
2626
```
27+
28+
## Building and publishing example project to repositories
29+
30+
1. Go to [{{ web_hosted_url | replace("http://", "")|replace("https://", "") }}]({{ web_hosted_url }}) and create a new project
31+
2. Specify sources location - path to Github repo `{{ examples_url }}` and sub-directory - `c_makefile` because the examples repo contains multiple projects in one repo and you want to build only one located in subdir
32+
3. Save, go to project page and click build now
33+
4. After the build and publishing is done you can find instructions how to instll the package on public download page
34+
35+
Now your package is hosted in repositories, signed by a generated GPG key (you can upload your own key), and can be installed using native package managers.

docs/new_project.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# How to build a new project from scratch
2+
3+
WIP

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ site_author: "Oleg Antonyan"
88
nav:
99
- Home: index.md
1010
- 'Getting started': getting_started.md
11+
- 'Building a new project': new_project.md
1112
- 'Self-hosting': self_hosting.md
12-
- About: about.md
1313

1414
extra:
1515
web_github_url: https://github.com/omnipackage/omnipackage-web

0 commit comments

Comments
 (0)