Update README

This commit is contained in:
akp 2024-11-07 15:32:16 +00:00
parent 82c8f29941
commit 7a1fd9c8c5
No known key found for this signature in database
GPG key ID: CF8D58F3DEB20755
2 changed files with 22 additions and 0 deletions

22
README.md Normal file
View file

@ -0,0 +1,22 @@
# pi-phone
*In a pinch? Need 100 digits of Pi? Call the Pi Hotline! +441834820860*
---
This codebase and the associated audio files forms the basis of a Twilio [TwiML](https://www.twilio.com/docs/voice/twiml) application that has a script something like this:
![flow chart of the phone line](flow.jpg)
Twilio is configured to, when the phone is called, run a webhook that points to the `/api/calls/new` route of this web server.
There is a small web page that is used to manually initiate phone calls, and the backend can be configured to schedule calls to be made at certain times.
The project structure is:
* `/pi-phone` - the main Go code that runs the TwiML server
* `/pi-phone/static/audio` - the source audio files to be played down the phone line
* `/stupid-option-2` - source audio files that were compiled to make `/pi-phone/static/audio/option-two.mp3`
* `/track-generator` - a small Python script used to generate an audio file reading the digits of Pi at a suitable speed
A systemd service is included in the base of this repository, and serves as an example of how to configure the server's environment variables.

BIN
flow.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB