Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rneher-igel committed Jan 5, 2024
1 parent 3ebf536 commit 9ef95bc
Showing 1 changed file with 47 additions and 2 deletions.
49 changes: 47 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,50 @@
# IGEL-OS-APP-SDK

Building Your Own IGEL OS App with igelpkg.

[Getting Started with the IGEL OS App SDK](utils/Getting-Started-with-the-IGEL-OS-App-SDK.pdf)

-----

-----

## Getting Started With the IGEL OS App SDK

This document provides you with the basic knowledge that is required to create an IGEL OS App with igelpkg and publish it on the IGEL App Portal.

Basically, the procedure is as follows:

- Install the IGEL OS App SDK on a Linux system.
- Build and test your app.
- Make sure that your app meets the requirements of the review by IGEL.
- Submit your app for review

-----

## Prerequisites

- Machine with Ubuntu Linux 18.04 or higher, or another Debian-based Linux distribution
- The IGEL OS APP SDK, version 0.9.8 or higher
- Device with IGEL OS 12.01.120. To test if the app can be installed and started, a virtual machine is sufficient. If 3D graphics are required, a hardware device might be a good choice. To test if an app can be installed and started, a virtual machine is sufficient.
- A local terminal is configured on the device

-----

## Installing igelpkg

- Copy the files igel-build-tools-static[version]_amd64.deb and igelpkg_[version]_amd64.deb to your development machine.
- Go to the directory that contains the files and enter the following command:

```bash linenums="1"
sudo apt install ./igel-build-tools-static[version]_amd64.deb igelpkg_[version]_amd64.deb
```

- To show the general help, enter

```bash linenums="1"
igelpkg --help
```

- To get help for a specific module, enter the module's name and then --help, for instance:

```bash linenums="1"
igelpkg build --help
```

0 comments on commit 9ef95bc

Please sign in to comment.