Skip to content

Latest commit

 

History

History
executable file
·
45 lines (19 loc) · 1.74 KB

DOCUMENTATION.md

File metadata and controls

executable file
·
45 lines (19 loc) · 1.74 KB

Documentation

This document contains the information you need to know to set up and use Predator.

Installation

If you're installing Predator on a system dedicated to its use (for example, on a single-board computer like a Raspberry Pi), you can use an auto-install script to automatically deploy the entire Predator ecosystem with a single command. To learn more, see docs/AUTOINSTALL.md

For normal installation instructions, see docs/INSTALL.md.

Configuration

The steps for configuring Predator, as well as complete descriptions of all configuration values, can be found in the docs/CONFIGURE.md document.

Usage

To learn more about how to start and use Predator's various modes, see the docs/USAGE.md file.

Hardware

Once you have the Predator software up and running, you may want to focus more on the hardware you plan to run it on. You can learn more about hardware requirements in the docs/HARDWARE.md file.

Troubleshooting

To learn about common problems, and suggested solutions, see the docs/TROUBLESHOOTING.md document.

Debugging

To learn how to use Predator's debug message feature to troubleshoot problems and improve processing speed, see the docs/DEBUGGING.md file.

Integration

Predator has several features that allow external programs to interface with it. To learn more about how to interface with Predator from external programs, see the docs/INTEGRATION.md document.

Updating

Updating between Predator versions may require certain steps to be repeated. To learn more about moving between Predator versions, see docs/UPDATE.md.