summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjacqueline <me@jacqueline.id.au>2023-09-20 15:16:26 +1000
committerjacqueline <me@jacqueline.id.au>2023-09-20 15:16:26 +1000
commit59e0de1fe268a580a49ffc0f91c83fdd88de385e (patch)
treecc6350c3082266d37f6f59348c436637d9b09ecb /README.md
parent4a686fee7eb890a1e2b5d70a8a6455544f58f120 (diff)
downloadtangara-fw-59e0de1fe268a580a49ffc0f91c83fdd88de385e.tar.gz
Add super basic readme for the sourcehut project
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..297e8b71
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Tangara
+
+Tangara is an open-hardware portable music player. It runs on an ESP32, fits in
+your pocket, and has a battery that lasts all day.
+
+## Source Repositories
+
+[tangara-fw](https://git.sr.ht/~jacqueline/tangara-fw): The ESP32 firmware,
+comprising the bulk of Tangara's functionality. This is probably the repo
+that you're most interested in!
+
+[tangara-hw](https://git.sr.ht/~jacqueline/tangara-hw): Sources for the entire
+physical device. Includes both the case/enclosure, and the PCBs.
+
+[tangara-samd-fw](https://git.sr.ht/~jacqueline/tangara-samd-fw): Firmware for
+the SAMD21 co-processor that manages USB connectivity, charging, and power
+management of the ESP32.
+
+## Contributing
+
+This repo is currently unlisted until we've gotten some kind of crowdfund together.
+How did you get here?