add stuff to README

README.md

@@ -2,7 +2,46 @@
 
 This script is mainly designed for large-scale vessels that need attitude stabilisation and (OPTIONAL) automatic control.
 
-You will need:
+This script stabilizes pitch and roll by default, and attempts to gain altitude until the set desired altitude is reached, where it will remain.
+
+The autopilot will always control heading, and will optionally control fore speed until it reaches a set point.
+
+Items like speed, altitude, etc. will be shown on the instrument panel monitor (at least a 1x3 monitor).
+
+Autopilot controls will be shown on the Autopilot Control monitor (at least a 2x2 monitor)
+
+## Monitor Information/Controls
+
+### Controls
+
+- Autopilot Master Enable
+- Autopilot Auto Throttle Enable
+- Autopilot Set Heading Enable
+  - Note: this will get ignored when the Navigation Table has a valid target
+- Autopilot Heading Hold Value
+- Autopilot Speed Hold Value
+- Altitude Set Enable
+- Altitude Hold Value
+- Master Fly-By-Wire Enable (this will disable all stabilisation features)
+
+### Readouts
+
+- Global Speed (Magnitude of the sum of all speed vectors)
+- Lateral speeds (fore/aft speed, up/down speed, port/starboard speed)
+- Global Acceleration
+- Up/Down Acceleration
+- Altitude
+- Heading
+- Pitch/Yaw/Roll angles
+
+## Mods Required
+
+- Create: Aeronautics
+- Create: Avionics
+- ComputerCraft: Tweaked (CC:Tweaked or CC:T)
+- Create Propulsion: Simulated
+
+## You will need
 
 - As many thrusters as needed to have sufficient thrust for your environment
   - Support for:
@@ -10,6 +49,7 @@ You will need:
       - Gyroscopic Propeller Bearing
       - Propeller Bearing
       - All single-block Propellers
+      - TODO: Support for `gas_provider` type.
     - Create Propulsion: Simulated
       - Fuel, Chemical, and Ion Thrusters
       - Vector & Liquid Vector Thrusters (the script will not take advantage of the thrust vectoring, so it is not reccommended to use them)
@@ -27,6 +67,8 @@ You will need:
 - As many wired modems and cable you need to connect all peripherals
   - This includes all explicitly named peripherals, all thrusters/propellers, and for each propeller, every speed-changer block that controls the speed for the propeller's network
 
+## Short Instructions
+
 When building your vessel, while connecting each thruster to the network, make sure to note down the thruster's peripheral name when you activate the modem, along with what cardinal directions it will affect when powered (fore, aft, port, starboard, up, and down).
 
 When you are finished, create a lua file at `/caero-attitude-control/config/thrusters.txt` according to the thrusters.txt.example file. Also, if you have any perisistent config changes, please set them in the `/caero-attitude-control/config/config.txt` file. Make sure this file exists and contains the thruster.txt file path.