diff --git a/README.md b/README.md index 1abe04a..4a70eca 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# Astraeus-I.github.io +# Astraeus-Library.github.io Organization wide repo for docs, assets, and tools any other static information. ## Updating the docs -Astraeus-I uses [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) to +Astraeus-Library uses [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) to generate our documentation. -If you'd like to contribute to the Astraeus-I website and documentation you can do +If you'd like to contribute to the Astraeus-Library website and documentation you can do so by first installing `mkdocs-material`. ```bash diff --git a/docs/about/about.md b/docs/about/about.md index 5b2de6a..347c0fc 100644 --- a/docs/about/about.md +++ b/docs/about/about.md @@ -1,13 +1,13 @@ # 🌐 About The Project -Astraeus-I originated as a senior project at San Jose State University, collaboratively developed over two semesters by a dedicated team of three students. This initiative was divided into two pivotal phases, with the initial semester focusing primarily on crafting the hardware, followed by a subsequent semester dedicated to the software development aspect. +Astraeus-Library originated as a senior project at San Jose State University, collaboratively developed over two semesters by a dedicated team of three students. This initiative was divided into two pivotal phases, with the initial semester focusing primarily on crafting the hardware, followed by a subsequent semester dedicated to the software development aspect. -During the course of its inception, our team had the opportunity to work closely with libhal, a collaborative effort that significantly contributed to the success and refinement of the project. This partnership was instrumental in navigating through the complexities and challenges that emerged during the development process, providing valuable insights and support that shaped Astraeus-I into its current form. +During the course of its inception, our team had the opportunity to work closely with libhal, a collaborative effort that significantly contributed to the success and refinement of the project. This partnership was instrumental in navigating through the complexities and challenges that emerged during the development process, providing valuable insights and support that shaped Astraeus-Library into its current form. ## 🔄 Project Phases -Hardware Development Phase: The first semester of the project was devoted to the intricate process of hardware development. This phase entailed rigorous research, planning, and implementation to construct a robust hardware foundation for Astraeus-I, ensuring its reliability and efficiency in performing its designated functions. +Hardware Development Phase: The first semester of the project was devoted to the intricate process of hardware development. This phase entailed rigorous research, planning, and implementation to construct a robust hardware foundation for Astraeus-Library, ensuring its reliability and efficiency in performing its designated functions. ## 🔩 Hardware Development Phase -The first semester of the project was devoted to the intricate process of hardware development. This phase entailed rigorous research, planning, and implementation to construct a robust hardware foundation for Astraeus-I, ensuring its reliability and efficiency in performing its designated functions. +The first semester of the project was devoted to the intricate process of hardware development. This phase entailed rigorous research, planning, and implementation to construct a robust hardware foundation for Astraeus-Library, ensuring its reliability and efficiency in performing its designated functions. ## 💻 Software Development Phase With a solid hardware base in place, the second semester was utilized for software development. This crucial phase involved coding, testing, and refining the software components to work seamlessly with the developed hardware, ultimately creating a cohesive and functional system. @@ -49,4 +49,4 @@ Engaging with libhal during the development process enriched our project with a ## 🙏 Acknowledgements -We extend our gratitude to San Jose State University and libhal for their unwavering support and resources that were invaluable to the successful completion of Astraeus-I. Special thanks also go to our mentors, advisors, and everyone who contributed their time and expertise to bring this project to fruition. We would firstly like to thank our co-advisor **Khalil Estell** for the tremendous amount of support and guidance he provided throughout the project. We would also like to thank our advisor **Kaikai Liu** for his valuable insights and feedback that helped us navigate through the complexities of the project. \ No newline at end of file +We extend our gratitude to San Jose State University and libhal for their unwavering support and resources that were invaluable to the successful completion of Astraeus-Library. Special thanks also go to our mentors, advisors, and everyone who contributed their time and expertise to bring this project to fruition. We would firstly like to thank our co-advisor **Khalil Estell** for the tremendous amount of support and guidance he provided throughout the project. We would also like to thank our advisor **Kaikai Liu** for his valuable insights and feedback that helped us navigate through the complexities of the project. \ No newline at end of file diff --git a/docs/board_packages/board_packages.md b/docs/board_packages/board_packages.md index d987722..df08e8d 100644 --- a/docs/board_packages/board_packages.md +++ b/docs/board_packages/board_packages.md @@ -3,11 +3,11 @@ The board packages tools for the Astraeus-I board comprise a suite of software r Designed with modularity in mind, these tools offer the flexibility to seamlessly integrate user-created applications onto the board. This design approach not only enhances usability but also encourages innovation and personalization. Additionally, the board application tools are crafted for portability, ensuring compatibility across various operating systems such as Linux, Windows, and macOS. This cross-platform functionality ensures that users have the freedom and convenience to develop and deploy their applications in diverse computing environments. -### 📡 [Telemetry Recorder](https://github.com/Astraeus-I/telemetry-recorder) +### 📡 [Telemetry Recorder](https://github.com/Astraeus-Library/telemetry-recorder) The Telemetry Recorder is a vital tool for capturing data from devices on the Astraeus-I board. It allows users to either save data directly to an SD card or transmit it through a radio module, provided the board is equipped with one. This dual functionality enables both immediate data transmission for real-time monitoring and secure data storage for later analysis. -To understand the Telemetry Recorder’s features and operation better, visit the project’s GitHub page. The repository also serves as a platform for collaboration, issue reporting, and community engagement to improve and develop the tool further. Whether you're a researcher, technician, or hobbyist, the Telemetry Recorder is a valuable asset for efficient data recording and transmission with the Astraeus-I board. +To understand the Telemetry Recorder’s features and operation better, visit the project’s GitHub page. The repository also serves as a platform for collaboration, issue reporting, and community engagement to improve and develop the tool further. Whether you're a researcher, technician, or hobbyist, the Telemetry Recorder is a valuable asset for efficient data recording and transmission with the Astraeus-I board. ## 🚧 Packages in Development 🚧 diff --git a/docs/getting_started/getting_started.md b/docs/getting_started/getting_started.md index ddcb8d7..3731e30 100644 --- a/docs/getting_started/getting_started.md +++ b/docs/getting_started/getting_started.md @@ -15,7 +15,7 @@ Please visit the Check out Libhal's API documentation here! -## 2: Astraeus Installation +## 2: Astraeus Library Installation Add the `astraeus` repository to your system. This repository holds all of the Astraeus packages. ```bash diff --git a/docs/index.md b/docs/index.md index f1d5d53..9ccd1e5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,22 +1,27 @@
-

Welcome to Astraeus-I

+

Welcome to the Astraeus-Library

## Abstract -Introducing **Astraeus-I**, a versatile multipurpose board meticulously designed for advanced avionic systems. Embedded with essential sensors, innovative modules, and customizable MicroMod processors, Astraeus-I stands out as an epitome of reliability and efficiency in the realm of avionics. +The Astraeus-Library is a curated collection of software packages, initially designed for the Astraeus-I board but with an ambitious vision that extends into avionic systems. At its core is libhal, a library that demystifies the complexity of hardware interfaces. Through libhal's unified API, we guarantee software portability across an expansive range of hardware platforms, enabling the same code to seamlessly operate on various processors and devices. This is especially crucial in the avionics sector, where reliability and adaptability are paramount. + +Our commitment to modular design in libhal not only facilitates current hardware integration but also lays the groundwork for future expansions. As we develop new boards specifically for avionics and other specialized applications, the Astraeus-Library evolves, becoming an increasingly versatile tool for developers. This forward-thinking approach ensures that the Astraeus-Library remains at the forefront of cross-platform compatibility and innovation, ready to meet both today's needs and tomorrow's challenges. ## Our Design Philosophy -Astraeus-I embodies a unique design philosophy centered on the following pillars: +Astraeus-Library embodies a unique design philosophy centered on the following pillars: 1. **Modularity:** Crafted to accommodate various avionic needs through its adaptable and interchangeable modules. 2. **Lightweight:** Engineered with precision to offer a lightweight yet robust solution for diverse avionic applications. -3. **High Performance:** Designed for optimum functionality, Astraeus-I delivers superior performance, making it ideal for a wide range of avionic applications. -4. **User-Friendly:** With an intuitive interface and straightforward integration process, Astraeus-I is accessible and easy to use, even for individuals who are not tech-savvy. +3. **High Performance:** Designed for optimum functionality, Astraeus-Library delivers superior performance, making it ideal for a wide range of avionic applications. +4. **User-Friendly:** With an intuitive interface and straightforward integration process, Astraeus-Library is accessible and easy to use, even for individuals who are not tech-savvy. ## The Basics -Astraeus-I seamlessly integrates interfaces with hardware devices and peripherals through effective use of runtime polymorphism. This technique allows for clear separation between application logic and driver implementation, ensuring smooth operation on platforms with the necessary components, emphasizing its versatility and compatibility. +Astraeus-Library seamlessly integrates interfaces with hardware devices and peripherals through effective use of runtime polymorphism. This technique allows for clear separation between application logic and driver implementation, ensuring smooth operation on platforms with the necessary components, emphasizing its versatility and compatibility. + +## Our Boards +Introducing **Astraeus-I**, a versatile multipurpose board meticulously designed for advanced avionic systems. Embedded with essential sensors, innovative modules, and customizable MicroMod processors, Astraeus-I stands out as an epitome of reliability and efficiency in the realm of avionics. Please fill out the [order form](order_form/order_form/) to get your hands on this avionics board. diff --git a/docs/project_information/status.md b/docs/project_information/status.md index f521943..f959144 100644 --- a/docs/project_information/status.md +++ b/docs/project_information/status.md @@ -17,16 +17,16 @@ - Astraeus-I/telemetry-recorder + Astraeus-Library/telemetry-recorder - + - + - + diff --git a/docs/user_guide/user_guide.md b/docs/user_guide/user_guide.md index cb01e21..2bcad24 100644 --- a/docs/user_guide/user_guide.md +++ b/docs/user_guide/user_guide.md @@ -31,7 +31,7 @@ To connect the Astraeus-I board with other devices, start by referencing the pin - Operating current: 200mA !!! note - For detailed information on the Astraeus board's schematic and board layout, refer to the Astraeus-I Board repository + For detailed information on the Astraeus board's schematic and board layout, refer to the Astraeus-I Board repository ## 💻 Software Details @@ -85,7 +85,7 @@ def requirements(self): self.requires("libhal-util/[^3.0.0]") ``` !!! note - Check out the telemetry recorder tool if you want to record data from the Astraeus-I board. + Check out the telemetry recorder tool if you want to record data from the Astraeus-I board. ## ⌨ Development Tools @@ -134,7 +134,7 @@ This cases are intended to be fabricated using any filament for an FDM printer i function getAssetPath(fileName) { const isLocal = window.location.hostname === 'localhost' || window.location.hostname === '127.0.0.1'; - return isLocal ? `../../assets/${fileName}` : `https://raw.githubusercontent.com/Astraeus-I/Astraeus-I.github.io/main/docs/assets/${fileName}`; + return isLocal ? `../../assets/${fileName}` : `https://raw.githubusercontent.com/Astraeus-Library/Astraeus-Library.github.io/main/docs/assets/${fileName}`; } function setupSTLViewer(containerId, stlFileName) { diff --git a/mkdocs.yml b/mkdocs.yml index 521b99f..11eb160 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ -site_name: Astraeus-I -repo_url: https://github.com/Astraeus-I -repo_name: Astraeus-I +site_name: Astraeus-Library +repo_url: https://github.com/Astraeus-Library +repo_name: Astraeus-Library theme: name: material @@ -55,7 +55,7 @@ plugins: extra: social: - icon: fontawesome/brands/github-alt - link: https://github.com/Astraeus-I + link: https://github.com/Astraeus-Library - icon: fontawesome/brands/discord link: https://discord.gg/7H8FzkXEgZ @@ -78,4 +78,4 @@ markdown_extensions: - attr_list copyright: | - © 2024 Astraeus-I \ No newline at end of file + © 2024 Astraeus-Library \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index eeea925..7258ff7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "Astraeus-I.github.io", + "name": "Astraeus-Library.github.io", "lockfileVersion": 3, "requires": true, "packages": {