# FRMS

## ForeLight Reactor Management System

This branch will serve as the staging ground for adding unit tests and documentation in order to finalize v0.1.0-alpha

## Table of Contents

* [Introduction](#introduction)
* [Getting Started](#getting-started)
    * [Installation](#installation)
    * [Usage](#usage)
* [Wiki](wiki/wiki.md)
    * [Overview](wiki/wiki.md#overview)
    * [Server](wiki/server.md)
    * [Reactor](wiki/reactor.md)
        * [Hardware](wiki/reactor.md#hardware)
    * [Networking](wiki/networking.md)
    * [GUI](wiki/gui.md)
    * [API](wiki/api.md)
    * [Future Work](wiki/future-work.md)

## Introduction

FRMS serves as both an internal framework for interacting with reactors as well as a scalable customer facing application.
The project makes heavy use of low-cost yet powerful embedded systems capable of running full Linux distributions. 
The [BeagleBone Black](https://beagleboard.org/black) is an example of the type of board used

## Getting Started

### Installation

### Usage

## Technical Information

### Overview

### Reactor

### Networking

### GUI

### API

### Future Work