Welcome to the Software Factory documentation

Version 1.0

---

The Software Factory documentation is the central space where we collect all useful information on how to work within the project.

---

About

• Software Factory concept
  • Introduction
  • Structure and nomenclature
  • How to use the SWF Platform Blueprint
  • Create a SWF deployment

Table of contents

• Version control usage
  • Git workflow
    • General setup
    • For each set of changes
    • Good commits
  • GitHub Tips and Tricks
    • Managing Pull requests
• Base Platform
  • Prerequisites for building a PELUX image
    • Dependencies for Debian users
  • Using the repo tool
    • Obtaining the repo tool
  • Manifests
    • Feature overview
    • Usage in yocto
    • Using the repo tool
  • Building PELUX sources
    • A note on development images
    • Building locally
    • Building with Vagrant
  • Reproducible Yocto builds
    • Intro
    • The AUTOREV problem
    • Building with BB_NO_NETWORK
    • Configuring Yocto builds for reproducibility
    • Saving the repo manifest
    • Reproducing the Yocto build
  • Writing the image
    • General instructions
    • Image names for PELUX targets
  • Booting on target hardware
    • NUC
    • Raspberry Pi 3
  • Building the SDK installer
  • Creating a manifest
    • Creating a git repo for a PELUX-based manifest
    • Tweaking the manifest files
  • Creating a new layer
    • Using Poky scripts for generating the layer
    • Using the new layer in a build
    • Suggested practices
  • Variant concept in Yocto
    • Recommended variant management
    • Recommended usage of variants
• Continuous integration and deployment
  • Infrastructure host
    • Host nginx configuration
  • Jenkins
    • Usage
    • Plugins
  • Build Slaves
    • Running a public slave
    • Running a private slave
  • Setting up automated testing on a NUC using Yocto
    • How it works
    • Preparing the NUC
    • Building and testing an image
  • Considerations for Continuous Integration jobs
    • General strategy
    • Yocto builds
  • PELUX Continuous Integration jobs
    • Jenkins jobs
• Software Development Kit
  • Fetching and installing the SDK
  • Installing the SDK
  • Using the SDK to cross compile
    • Sourcing The Environment
    • Cross Compiling
  • Deploying and running a binary executable on target
• Software Development Environment
  • Starting the SDE
    • Used environment variables
  • Developing and Extending the SDE
    • Test framework
    • Stubbed SDK
  • Downloading the PELUX-SDE
  • Related articles
    • How to cross compile using Qt Creator and PELUX SDE
• Architecture
  • Introduction and goals
    • Reader’s guide
  • Architecture concepts
  • Vertical configurations
    • Update management
  • SOTA client
    • Introduction and goals
    • Constraints
    • System scope and context
    • Solution strategy
    • Building blocks view
    • Runtime view
    • Deployment view
    • Cross-cutting concepts
    • Design decisions
    • Quality requirements
    • Risks and technical debts
    • Glossary
    • Appendix: case studies
  • Glossary
• C/C++ templates
  • Source code repository directory structure
    • Mandatory files
    • Directory naming
    • File naming
  • Template library
    • Compilation and installation
  • Template service
    • Dependencies
    • Compilation and installation
    • Running the template service
  • Install directory structure
  • Yocto Project integration
    • Template recipes
    • Target image integration
• Licensing
• Releasing PELUX
  • PELUX Release Process
    • Source release
    • Binary release
  • Creating a PELUX release
    • Tasks needed to prepare PELUX for release
    • How-to perform the tasks

Categories

• How-to articles
• Processes