Skip to content

Commit

Permalink
📝 updates documentation for install astraeus binary packages
Browse files Browse the repository at this point in the history
  • Loading branch information
acarrou committed Feb 20, 2024
1 parent 9c5239c commit a4f7eba
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 22 deletions.
20 changes: 16 additions & 4 deletions docs/getting_started/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,31 @@
# 🚀 Getting Started

In this section, we will cover the basics of getting started with installing libhal on your machine and flashing the Astraeus-I board. We will also cover how to create your own project.
In this section, we will cover the basics of getting started with installing libhal and astraeus packages on your machine and flashing the Astraeus-I board. We will also cover how to create your own project.

### 🧰 Installing Dependencies

Libhal is a software library designed to abstract complexities associated with interfacing with different hardware platforms. By offering a unified API, libhal enables developers to write software that's independent of the underlying hardware specifics. This allows for seamless portability across different platforms, ensuring that the same code can be used to run on different processors, mircrocontrollers, systems, and devices. Libhal is designed to be modular and extensible. This allows developers to add support for new hardware platforms and devices.
**Libhal** is a software library designed to abstract complexities associated with interfacing with different hardware platforms. By offering a unified API, libhal enables developers to write software that's independent of the underlying hardware specifics. This allows for seamless portability across different platforms, ensuring that the same code can be used to run on different processors, mircrocontrollers, systems, and devices. Libhal is designed to be modular and extensible. This allows developers to add support for new hardware platforms and devices.

## <img class="package_logo_small" src="../../assets/libhal.png" style="width: 30px; height: auto;"> Libhal Installation
**Astraeus** is a collection of packages that are built on top of libhal. These packages are designed to be used with the Astraeus-I board.

## 1: <img class="package_logo_medium" src="../../assets/libhal.png" style="width: 40px; height: auto;"> Libhal Packages

Please visit the <a href="https://libhal.github.io/2.4/getting_started/" target="_blank">libhal docs</a>
to learn how to install and configure libhal on your machine. Make sure you go through all of the steps in the docs before continuing. This includes installing and flashing to your Astraeus-I board.

> Check out Libhal's API documentation <a href="https://libhal.github.io/2.4/api/" target="_blank">here!</a>
## 🧱 Creating Your Own Project
## 2: <img class="package_logo_medium" style="height:40px;" src="../../assets/logo.png"> Astraeus Installation

Add the `astraeus` repository to your system. This repository holds all of the Astraeus packages.
```bash
conan remote add astraeus https://libhal.jfrog.io/artifactory/api/conan/astraeuslibrary-conan
```




## 3: 🧱 Creating Your Own Project

Start by cloning `libhal-starter`:

Expand Down
21 changes: 3 additions & 18 deletions docs/project_information/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,18 @@
</th>
</tr>

<!-- <tr>
<tr>
<td>
<a href="https://github.com/Astraeus-I/telemetry-recorder">Astraeus-I/telemetry-recorder</a>
</td>
<td>
<a href="https://github.com/Astraeus-I/telemetry-recorder/actions/workflows/ci.yml"><img src="https://github.com/Astraeus-I/telemetry-recorderactions/workflows/ci.yml/badge.svg" /></a>
<a href="https://github.com/Astraeus-I/telemetry-recorder/actions/workflows/ci.yml"><img src="https://github.com/Astraeus-I/telemetry-recorder/actions/workflows/ci.yml/badge.svg" /></a>
</td>
<td>
<img src="https://astraeus-i.github.io/telemetry-recorder/coverage/coverage.svg">
</td>
<td>
<a href="https://github.com/Astraeus-I/telemetry-recorder/blob/main/conanfile.py"><img src="https://github.com/Astraeus-I/telemetry-recorder/latest_version.svg" /></a>
</td>
</tr> -->

<tr>
<td>
<a href="https://github.com/Astraeus-I/telemetry-recorder/" target="_blank">Astraeus-I/telemetry-recorder</a>
</td>
<td>
<a href="https://github.com/libhal/libhal-icm/actions/workflows/ci.yml"><img src="https://github.com/libhal/libhal-icm/actions/workflows/ci.yml/badge.svg" /></a>
</td>
<td>
<img src="https://libhal.github.io/libhal-icm/coverage/coverage.svg">
</td>
<td>
<a href="https://github.com/libhal/libhal-icm/blob/main/conanfile.py"><img src="https://libhal.github.io/libhal-icm/latest_version.svg" /></a>
<a href="https://github.com/Astraeus-I/telemetry-recorder/blob/main/conanfile.py"><img src="https://astraeus-i.github.io/telemetry-recorder/latest_version.svg" /></a>
</td>
</tr>

Expand Down

0 comments on commit a4f7eba

Please sign in to comment.