Update readme

Author: pierr3

README.md

@@ -2,6 +2,109 @@
 
 A next generation Audio-For-VATSIM ATC Client for macOS, Linux and Windows.
 
-## Required linux packages for libuiohook
+![screengrab of application](https://raw.githubusercontent.com/pierr3/TrackAudio/main/docs/app_screenshot_apr2024.png)
 
-`libxt-dev libxrandr-dev libxtst-dev libx11-dev`
+## Note
+
+This software is in beta, and is missing features or may be broken in some places. Report any issues on GitHub. It is, however, ready for use on the network and you should not encounter major issues.
+
+## Releases
+
+See [releases](https://github.com/pierr3/TrackAudio/releases) for latest builds
+
+## FAQ
+
+### What's the difference between VectorAudio and TrackAudio?
+
+TrackAudio is simply the next iteration of VectorAudio, using a different set of technology. While TrackAudio is still in beta, you should try to use it instead of VectorAudio, as the latter will no longer be supported at some point.
+
+### My PTT does not work on macOS
+
+macOS has strict permissioning around background keyboard inputs. TrackAudio should prompt you on first launch to request accesibility permissions. Sometimes, upon updating the app, this setting will undo itself. In that case, please go to your Settings -> Privacy & Security -> Accessibility and add TrackAudio in the list (remove it if it was already there).
+
+<!-- ### Where is the configuration file/log file stored?
+
+On macOS: `~/Library/Application\ Support/VectorAudio`
+On Linux: `~/.config/vector_audio`
+On Windows: where VectorAudio.exe is installed -->
+
+### Does TrackAudio support joystick PTT?
+
+Not at the moment.
+
+### The station I am trying to add is not found
+
+Ask your FE to define the station in the AFV database. Per the AFV FE manual, all stations should be defined in the database. TrackAudio does support ad-hoc station creation if you log-in as a DEL, GND or TWR that has no station definition. It will then place a transceiver at your center of visibility set in your controller client.
+
+### Is there RDF support in EuroScope?
+
+Yes! @KingfuChan has updated the RDF plugin for EuroScope to include support for TrackAudio. Find the plugin [in this repo](https://github.com/KingfuChan/RDF/).
+
+### Does TrackAudio support HF Simulation?
+
+Yes, but only if you add a frequency by callsign (must be defined in database). HF Squelch is enabled by default
+
+### Can I add a frequency manually if it does not exist in the database?
+
+Yes, using the menu on the right, however, this will only create one transceiver (antenna) at your center of visibility set in your atc client. This means that you will not get the same radio coverage as stations defined in database.
+
+### What is XC and XCA?
+
+When you left click XC on a frequency that you are listening to, and if you are logged in as ATC, all the transceivers of that frequency will be cross-coupled. This means that all transmissions received by a transceiver in that list will also be re-emitted by all other transceivers. This allows for pilots in different parts of your airspace to hear eachother, since they may be using a different transceiver. In general, you should be using XC every time you control.
+
+When you right click XC, you activate "cross-couple across". This allows you to cross-couple across frequencies, meaning you can join multiple sets of transceivers regardless of frequency.
+Pay attention, however, as you may cause overlap of radio by enabling this. For example, if you XCA one frequency that has a transceiver near the border of a neighboring vAcc with another that is at the other end of your sector, far away from that border with your neighboring vAcc, you will suddenly extend coverage of that second frequency to the border with your neighboor.
+This feature is mostly useful for CTR positions, when regrouping large sectors together.
+
+### Can I extend TrackAudio using a plugin/is there an SDK?
+
+Yes! Have a look [in the wiki](https://github.com/pierr3/TrackAudio/wiki/SDK-documentation). TrackAudio offers a WebSocket and HTTP SDK. If you need additional features, please open an issue with a detailed request, I'll be happy to look at it with no guarantees.
+
+### I have an issue with TrackAudio
+
+Read this document entirely first. If you can't find the answer to your problem, please [open an issue](https://github.com/pierr3/TrackAudio/issues/new) on GitHub, attaching relevant lines from the afv.log file that should be in the same folder as the executable.
+
+## Installation
+
+### Linux
+
+TrackAudio is packaged as a .dep and should run without any specific actions.
+
+Download the latest release on the [release page](https://github.com/pierr3/TrackAudio/releases) and run the .deb
+If it does not open, you might want to make sure it has permission to run as an executable by running `chmod +x` on the .deb File.
+
+Note: this will install libafv_native.so in /usr/lib, a required library for TrackAudio to run.
+
+### macOS
+
+Download the latest release on the [release page](https://github.com/pierr3/TrackAudio/releases) and install the .app into your applications folder.
+
+TrackAudio is available in two versions, one for apple silicon (arm64) and one for intel macs (x64).
+
+### Windows
+
+Download the latest release on the [release page](https://github.com/pierr3/TrackAudio/releases) and run the executable. This should install TrackAudio.
+
+## Build
+
+### Dependencies
+
+TrackAudio depends on afv-native and libuiohook.
+
+`cmake` is required to build the project. Dependencies will be downloaded through vcpkg at build time. See vcpkg.json for further details
+
+On linux, the following packages are required: `build-essentials libxt-dev libxrandr-dev libxtst-dev libx11-dev`, you may also need further packages to enable the different audio backends, such as Alsa, JACK or PulseAudio.
+On macOS, XCode Command Line tools, CMake and Homebrew are required and the following homebrew package is required: `pkg-config`
+
+## Build process
+
+```sh
+npm install
+git submodule update --init --recursive
+npm run build-backend
+npm run start
+```
+
+## Contributing
+
+If you want to help with the project, you are always welcome to open a PR. 🙂