You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

56 lines
1.8 KiB
Markdown

3 years ago
# FRMS
3 years ago
## ForeLight Reactor Management System
3 years ago
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 testing reactor designs as well as a scalable customer facing application for monitoring and control.
The project makes heavy use of low-cost yet powerful embedded systems capable of running full Linux kernels.
Examples include the [BeagleBone Black](https://beagleboard.org/black) which was heavily used in development of FRMS as well as the popular [Raspberry Pi 4](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/).
For more information about the hardware used in the reactors see [here](wiki/reactor.md#hardware).
In its current state, FRMS is very bare bones and exists mostly as a proof of concept.
There are several routes to improving the software described in the [future work](wiki/future-work.md) section.
To get started with FRMS see [here](#getting-started).
For further information about any of the technical information see [here](wiki/wiki.md).
For any bugs/questions please file an issue [here](https://github.com/fl-src/FRMS/issues/new).
## Getting Started
### Installation
### Usage
## Technical Information
### Overview
### Reactor
### Networking
### GUI
### API
### Future Work