Getting Started

Welcome to the Nexus Embedded Platform! This guide will help you get started with Nexus, from installation to building your first application.

Contents:

• Introduction to Nexus
  • What is Nexus?
  • Why Choose Nexus?
  • Core Features
  • Supported Platforms
  • Architecture Overview
  • Design Philosophy
  • Who Uses Nexus?
  • Use Cases
  • Getting Started
  • Project Status
  • Community
  • Next Steps
• Environment Setup
  • System Requirements
  • Required Tools
  • Installation Instructions
  • Python Dependencies
  • Verify Installation
  • Clone Nexus Repository
  • IDE Setup (Optional)
  • Hardware Setup
  • Troubleshooting
  • Next Steps
  • See Also
• Quick Start
  • Prerequisites
  • Choose Your Platform
  • 5-Minute Quick Start (Native)
  • Quick Start for STM32F4
  • Exploring Examples
  • Build Options
  • Debugging
  • Common Issues
  • Next Steps
  • See Also
• Project Structure
  • Overview
  • Directory Structure
  • Configuration Files
  • File Naming Conventions
  • Code Organization
  • Navigation Tips
  • Next Steps
  • See Also
• Build and Flash
  • Build System Overview
  • Build Methods
  • Using Python Build Scripts
  • Using CMake Directly
  • Build Configuration
  • Kconfig Configuration
  • Build Output
  • Flashing to Hardware
  • Debugging
  • Serial Console
  • Troubleshooting
  • Next Steps
  • See Also
• First Application
  • What We’ll Build
  • Prerequisites
  • Project Setup
  • Application Code
  • Build and Test
  • Enhancements
  • Next Steps
  • See Also
• Core Concepts
  • Architecture Overview
  • Hardware Abstraction Layer (HAL)
  • OS Abstraction Layer (OSAL)
  • Framework Layer
  • Configuration System (Kconfig)
  • Memory Management
  • Error Handling
  • Resource Management
  • Best Practices
  • Next Steps
  • See Also
• Configuration
  • What is Kconfig?
  • Configuration Files
  • Configuration Workflow
  • Configuration Options
  • Using Configuration in Code
  • Configuration Examples
  • Advanced Topics
  • Menuconfig (Linux/macOS)
  • Troubleshooting
  • Best Practices
  • Next Steps
  • See Also
• Examples Tour
  • Overview
  • Blinky Example
  • Shell Demo Example
  • Config Demo Example
  • FreeRTOS Demo Example
  • Comparing Examples
  • Modifying Examples
  • Next Steps
  • See Also
• Frequently Asked Questions
  • General Questions
  • Installation and Setup
  • Building and Compilation
  • Flashing and Debugging
  • Configuration
  • Development
  • Testing
  • Troubleshooting
  • Getting Help
  • Contributing
  • License
  • Next Steps

What You’ll Learn

This getting started guide covers:

• Introduction: What is Nexus and why use it

• Environment Setup: Installing tools and dependencies

• Quick Start: Build and run your first example in 5 minutes

• Project Structure: Understanding the codebase organization

• Build & Flash: Compiling and deploying to hardware

• First Application: Creating your own application from scratch

• Core Concepts: Understanding Nexus architecture

• Configuration: Using Kconfig to customize your build

• Examples Tour: Exploring the included demo applications

• FAQ: Common questions and troubleshooting

Prerequisites

Before starting, you should have:

• Basic knowledge of C programming

• Familiarity with embedded systems concepts

• A development board (STM32F4 Discovery recommended) or willingness to use native simulation

• Comfortable using command-line tools

Recommended Learning Path

We recommend following the guides in order:

1. Start with Introduction to Nexus to understand what Nexus offers

2. Follow Environment Setup to install required tools

3. Try Quick Start to build your first example

4. Read Project Structure to understand the codebase

5. Learn Build and Flash for deployment workflows

6. Create First Application to build something custom

7. Study Core Concepts for deeper understanding

8. Master Configuration to customize your build

9. Explore Examples Tour for more complex examples

10. Refer to Frequently Asked Questions when you encounter issues

Quick Links

• Quick Start - Get started in 5 minutes

• Tutorials - Step-by-step tutorials

• User Guide - Detailed user guides

• Platform Guides - Platform-specific information

• API Reference - API reference documentation

Need Help?

• GitHub Issues - Report bugs

• GitHub Discussions - Ask questions

• Frequently Asked Questions - Common questions and answers

• Contributing - Contributing guide