#+title: Igloo
#+author: Penguin
#+Date: 5/6/2023
#+OPTIONS: ^:nil

* WIP: What is Igloo?

Igloo is a project management tool for C/C++ projects. It supports embedded and non-embedded systems projects. Igloo aims to be for C/C++ what cargo is for Rust. I was tired of manually making the same makefiles over and over again. I was tired of downloading BSPs from manufacturers websites and manually stringing together the same project structure over and over again. So I made Igloo.

* WIP: How does igloo work?
Igloo has many moving parts in order to keep a compatible, working interface between embedded and non-embedded projects. A diagram is being worked on currently. Igloo creates and manages projects. It works with another component (snowman) to manage packages that hold piece together different components required for a working project.

* Getting Started
** Installation
*** TODO: Gentoo
*** TODO: Ubuntu
*** TODO: Arch
*** TODO: Manual (Binary) Installation
*** TODO: Manual (Source) Installation
** Usage
*** TODO: Creating a project
*** TODO: Running a project
*** TODO: Debugging a project
*** TODO: Creating an embedded project
*** TODO: Flashing an embedded target
*** TODO: Debugging an embedded target
** Configuration
Igloo follows the normal configuration path for linux. It looks (in order) at:
- /etc/igloo/config.toml
- $HOME/.config/igloo/config.toml
- <project_root>/.igloo/config.toml

Example configs can be found here:

src_path[:exports code]{/usr/share/doc/igloo-<version_major>-<version_minor>-<version_patch>/}

* Supported Hardware
A full list of supported MCUs can be found [[./SUPPORTED_HARDWARE.org][here]].