Add README and LICENSE

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..4236baa
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Trent Huber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..f714aae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Tandy Graphics Adapter Controller
+
+This project uses the programmable I/O found on the Raspberry Pi Pico 2 to drive a [CM-5 monitor](https://dfarq.homeip.net/tandy-cm-5-monitor/) using the [Tandy Graphics Adapter display standard](https://en.wikipedia.org/wiki/Tandy_Graphics_Adapter). 
+
+![Here is an image of the Pico 2 hooked up to the monitor.](reference/cm5.jpeg "My current setup")
+
+## Building
+
+Assuming you have the Raspberry Pi SDK installed with the relevant path variables set up, building the project is as follows.
+
+```console
+$ git clone https://github.com/trenthuber/rp2350-tga
+$ cd rp2350-tga
+$ mkdir build
+$ cd build
+$ cmake -DPICO_PLATFORM=rp2350-arm-s ..
+$ cmake --build .
+```
+
+The resulting `tga.uf2` file can be copied to the Pico 2.
+
+## Troubleshooting
+
+Given the lack of [documentation](reference/cm5.pdf) (or, more likely, my lack of understanding it) I can only *assume* the CM-5 monitor operates at a 5V TTL level. This would of course be an issue since the Pico operates at 3.3V and would explain why I was unable to test the code simply by plugging the Pico directly into the monitor. It would seem we need a way of boosting the TTL level of the Pico---perhaps with some special IC---before we're able to test the PIO code.

diff --git a/reference/cm5.jpeg b/reference/cm5.jpeg
new file mode 100644 (file)
index 0000000..94197a9
Binary files /dev/null and b/reference/cm5.jpeg differ