diff --git a/README.md b/README.md index b6e1aed71..5fcb15046 100644 --- a/README.md +++ b/README.md @@ -87,4 +87,4 @@ After our rate of change slows a bit, we will make beta builds available here (w # Development -We'd love to have you join us on this merry little project. Please see our [development documents](./docs/software/sw-design.md) \ No newline at end of file +We'd love to have you join us on this merry little project. Please see our [development documents](./docs/software/sw-design.md) and join us on the gitter chat above. \ No newline at end of file diff --git a/TODO.md b/docs/software/TODO.md similarity index 99% rename from TODO.md rename to docs/software/TODO.md index 39ccb328f..3e5c8360c 100644 --- a/TODO.md +++ b/docs/software/TODO.md @@ -3,8 +3,6 @@ Items to complete soon (next couple of alpha releases). * add a getting started page -* add links to todos -* link to the kanban page * finish mesh alg reeval * lower wait_bluetooth_secs to 30 seconds once we have the GPS power on (but GPS in sleep mode) across light sleep. For the time being I have it set at 2 minutes to ensure enough time for a GPS lock from scratch. @@ -195,3 +193,5 @@ until the phone pulls those packets. Ever so often power on bluetooth just so w Have state machine properly enter deep sleep based on loss of mesh and phone comms. Default to enter deep sleep if no LORA received for two hours (indicates user has probably left the mesh). * (fixed I think) text messages are not showing on local screen if screen was on +* add links to todos +* link to the kanban page \ No newline at end of file diff --git a/docs/software/sw-design.md b/docs/software/sw-design.md index c588f7b80..d6413dda7 100644 --- a/docs/software/sw-design.md +++ b/docs/software/sw-design.md @@ -1,6 +1,8 @@ -This is a mini design doc for various core behaviors... +This is a mini design doc for developing the meshtastic software. * [Build instructions](build-instructions.md) +* [TODO](TODO.md) - read this if you are looking for things to do (or curious about currently missing features) +* Our [project board](https://github.com/orgs/meshtastic/projects/1) - shows what things we are currently working on and remaining work items for the current release. * [Power Management](power.md) * [Mesh algorithm](mesh-alg.md) * [Bluetooth API](bluetooth-api.md) and porting guide for new clients (iOS, python, etc...)