diff --git a/README.md b/README.md index 3fd0085..44f424c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,20 @@ # apple2idiot -A general purpose ESP32 Wifi and Bluetooth board for the Apple II family of computers (with expansion slots). +A general purpose ESP32 Wifi and Bluetooth board for the Apple II family of +computers (with expansion slots). -This card is essentially an ESP32 module and a dual-port ram chip. The Apple computer and the ESP communicate via the dual-port ram. That means that the ESP32 doesn't acutally have access to read/write any of the Apple computer's data or address busses. I think that's ok. In fact, I think this card is so simple, and stupid, that lots of fun little things can be done with it, but it's not meant to "get your Apple on the internet". +This card is essentially an ESP32 module and a dual-port ram chip. The Apple +computer and the ESP communicate via the dual-port ram. That means that the +ESP32 doesn't acutally have access to read/write any of the Apple computer's +data or address busses. I think that's ok. In fact, I think this card is so +simple, and stupid, that lots of fun little things can be done with it, but +it's not meant to "get your Apple on the internet". -As a user of the card, you write the software that runs on the ESP32 module, and the software that runs on the Apple computer. In the `examples/` folder are examples of how to do simple little things. Software on the apple just peeks/pokes commands and data to the ram chip, and the ESP responds however it's programmed to resppond. +As a user of the card, you write the software that runs on the ESP32 module, +and the software that runs on the Apple computer. In the `examples/` folder +are examples of how to do simple little things. Software on the apple just +peeks/pokes commands and data to the ram chip, and the ESP responds however +it's programmed to resppond. ## Some of the example programs that have been developed so far @@ -17,13 +27,11 @@ As a user of the card, you write the software that runs on the ESP32 module, and ### The Card -This is actively being developed (as of September 2021). The rev 0.1 board doesn't work without -some bodge wires, and rev 0.2 boards are on their way from China. +This is actively being developed (as of September 2021). The rev 0.2 boards have arrived, and they work as designed. The gerber files are here in the repo. ### The Apple II Software -None of the Apple //e code is up yet because I don't have a way to transfer it -from my 5.25 floppies to here. I hope to fix this soon. +There are examples written in BASIC and in cc65 in the `examples/` directory. ### The Card Software/Firmware @@ -45,4 +53,3 @@ Here are some things I'm interested in making work... There are lots of jobs both little and big and hard and easy for someone looking for a project to join. Take a look at the list above for ideas. Feel free to email me at nathanhendler@gmail.com. - diff --git a/examples/README.md b/examples/README.md index b008406..c35d122 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,9 +1,13 @@ # apple2idiot A general purpose ESP32 IOT board for the Apple IIe -# Requirements +The best example at the moment is `weather/`. -## Arduino Libraries +## Potential requirements + +Some of these examples require things. Here are some notes I've been taking... + +### Arduino Libraries + https://github.com/me-no-dev/ESPAsyncWebServer + https://github.com/me-no-dev/AsyncTCP @@ -21,8 +25,6 @@ mv AsyncTCP-master AsyncTCP mv ESPAsyncWebServer-master ESPAsyncWebServer ``` -## Potential requirements - For ESP32 webserver to serve static files... + https://github.com/me-no-dev/arduino-esp32fs-plugin diff --git a/examples/weather/README.md b/examples/weather/README.md new file mode 100644 index 0000000..e37e8a7 --- /dev/null +++ b/examples/weather/README.md @@ -0,0 +1,6 @@ +# Apple2 Internet Weather Client Example + +#. Use the arduino-cli or ide to transfer weather.ino to the ESP32 on the apple2idiot card. +#. Use either `WEATHER.BAS` or the `/apple2-cc65/weather.dsk` on your Apple ][. + + diff --git a/examples/weather/apple2-cc65/COMPILE.md b/examples/weather/apple2-cc65/COMPILE.md deleted file mode 100644 index 47a9da3..0000000 --- a/examples/weather/apple2-cc65/COMPILE.md +++ /dev/null @@ -1,5 +0,0 @@ -``` -make -make TARGETS=apple2 dsk -``` -cp weather.dsk ~/bin/ADTPro-2.1.0/disks/ diff --git a/examples/weather/apple2-cc65/README.md b/examples/weather/apple2-cc65/README.md index d40024a..8fb40b6 100644 --- a/examples/weather/apple2-cc65/README.md +++ b/examples/weather/apple2-cc65/README.md @@ -2,3 +2,14 @@ This is the C code to compile the software that runs on an Apple2 and makes use of the Apple2idiot card to display the weather for a given city. + + +## How I use this + +This is how I compile, make a disk and then stage the disk for transfer to my //c using ADTPro. + +``` +make +make TARGETS=apple2 dsk +cp weather.dsk ~/bin/ADTPro-2.1.0/disks/ +```