Awesome

Adamant Example Project

This repository contains an example project which utilizes the Adamant software framework. Its purpose is to demonstrate how the framework can be used to create components, unit test components, and connect those components together into an executable assembly.

The project can be compiled for two different targets, a Linux desktop environment and the Raspberry Pi Pico.

Getting Started

1. First, we need to set up the development environment for the project by following this guide.
2. Build, run, and explore the Linux assembly.
3. Build, run, and explore the Raspberry Pi Pico assembly.
4. Copy, modify, and adapt the example project for your own project.

Need Help?

• Have a question or suggestion? Please use the project's discussions.
• Find a bug? Please submit an issue.

Contributing

Contributions are welcome! This repository follows the guidelines from the main Adamant repository. For details see CONTRIBUTING.md.

Resources

Below are some helpful resources for learning up on Adamant and the various tools used in this framework.

• The design documents for the example assemblies can be found here: Linux, Raspberry Pi Pico.
• The Architecture Description Document provides an overview of Adamant's architecture and main concepts.
• The User Guide is a comprehensive resource for developers looking to start using the Adamant framework.
• New to Ada or SPARK? Learn more here. But familiar with C++ or Java? Take a look at this guide.
• Learn more about Adamant's redo-based build system.

Directory Structure

The following is a description of what you can expect to find in the subdirectories of this directory.

• config/ - Adamant configuration file for the project
• env/ - files used for configuring the development environment used by the project
• redo/ - redo build files for the project
• src/ - the source code which makes up the project
• docker/ - files for configuring the development environment used for this project