updat README with some best practices
This commit is contained in:
15
README.md
15
README.md
@@ -1,10 +1,21 @@
|
|||||||
Init readme
|
# Off Grid Talkies
|
||||||
|
|
||||||
|
Soon to be followed by off grid walkies.
|
||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
### antennae stuff
|
### antennae stuff
|
||||||
|
|
||||||
https://learn.adafruit.com/adafruit-feather-m0-radio-with-lora-radio-module/antenna-options
|
<https://learn.adafruit.com/adafruit-feather-m0-radio-with-lora-radio-module/antenna-options>
|
||||||
|
|
||||||
|
### Code Practices
|
||||||
|
|
||||||
|
- All macros and constants in caps: `MAX_BUFFER_SIZE`, `TRACKING_ID_PREFIX`.
|
||||||
|
- Struct names and typedef's in camelcase: `GtkWidget`, `TrackingOrder`.
|
||||||
|
- Functions that operate on structs: classic C style: `gtk_widget_show()`,
|
||||||
|
`tracking_order_process()`.
|
||||||
|
- Pointers: nothing fancy here: `GtkWidget *foo`, `TrackingOrder *bar`.
|
||||||
|
- Global variables: just don't use global variables. They are evil.
|
||||||
|
- Functions that are there, but shouldn't be called directly, or have obscure uses, or
|
||||||
|
whatever: one or more underscores at the beginning: `_refrobnicate_data_tables()`,
|
||||||
|
`_destroy_cache()`.
|
||||||
|
|||||||
Reference in New Issue
Block a user