diff --git a/docs/getting_started/getting_started.md b/docs/getting_started/getting_started.md index e722d47..ddcb8d7 100644 --- a/docs/getting_started/getting_started.md +++ b/docs/getting_started/getting_started.md @@ -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. -## 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: Libhal Packages Please visit the libhal docs 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 here! -## 🧱 Creating Your Own Project +## 2: 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`: diff --git a/docs/project_information/status.md b/docs/project_information/status.md index 501335a..f521943 100644 --- a/docs/project_information/status.md +++ b/docs/project_information/status.md @@ -15,33 +15,18 @@ - - - - - Astraeus-I/telemetry-recorder - - - - - - - - - +