From adc57d8d44d324503ae25ad74a70f85487a57033 Mon Sep 17 00:00:00 2001 From: Andy Piper <andypiper@users.noreply.github.com> Date: Wed, 19 Jun 2024 14:05:11 +0200 Subject: [PATCH] Lots of small spelling fixes. --- docs/hexpansions/creating-hexpansions.md | 2 +- docs/hexpansions/writing-hexpansion-apps.md | 2 +- docs/index.md | 6 +++--- docs/tildagon-apps/examples/bitmaps.md | 1 - docs/tildagon-apps/examples/inter-badge-communications.md | 4 ++-- docs/tildagon-apps/index.md | 2 +- docs/tildagon-apps/reference/ctx.md | 2 +- docs/tildagon-apps/reference/ui-elements.md | 2 +- docs/tildagon-apps/simple_tildagon.md | 4 ++-- docs/tildagon-firmware/index.md | 2 +- docs/using-the-badge/connect-to-wifi.md | 4 ++-- 11 files changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/hexpansions/creating-hexpansions.md b/docs/hexpansions/creating-hexpansions.md index 1a217cc..e6e6d8f 100644 --- a/docs/hexpansions/creating-hexpansions.md +++ b/docs/hexpansions/creating-hexpansions.md @@ -38,7 +38,7 @@ On the rest of this page, you will find the spec for the requirements these hexp **A hexpansion must be 1mm thick!** If it's any other thickness, it will not fit the port, and it will not work. The connector itself specifies a 0.1mm tolerance for thickness. -You can make a hexpansion by cutting out a shape out of any sufficiently stiff non-conductive material. The simplest hexpansion is a piece of 1mm cardstock cut into a particular shape. +You can make a hexpansion by cutting out a shape out of any sufficiently stiff non-conductive material. The simplest hexpansion is a piece of 1mm card stock cut into a particular shape. If you're laser-cutting a hexpansion out of plastic, note that _cast_ acrylic sheet can vary quite a lot in thickness. _Extruded_ acrylic sheet has better dimensional tolerance and is recommended for building hexpansions. diff --git a/docs/hexpansions/writing-hexpansion-apps.md b/docs/hexpansions/writing-hexpansion-apps.md index 5857f68..b626476 100644 --- a/docs/hexpansions/writing-hexpansion-apps.md +++ b/docs/hexpansions/writing-hexpansion-apps.md @@ -14,7 +14,7 @@ There are three options for your hexpansion app: 2. Your hexpansion has an EEPROM, but your app is going to be downloaded from the app store and run separately. 3. Your hexpansion does not have an EEPROM, so your app will be downloaded from the app store and run separately. -Which aproach you use is dependent on the hexpansion you're writing an app for and your own personal preference. If your app is likely to be so large that it'll exceed the space on the EEPROM, you might want to explore cross-compiling your app using [mpy-cross](https://pypi.org/project/mpy-cross/) to reduce its size. If your app is still too large, option 2 is your best bet. +Which approach you use is dependent on the hexpansion you're writing an app for and your own personal preference. If your app is likely to be so large that it'll exceed the space on the EEPROM, you might want to explore cross-compiling your app using [mpy-cross](https://pypi.org/project/mpy-cross/) to reduce its size. If your app is still too large, option 2 is your best bet. If you're confident that your app will fit within the EEPROM filesystem of your hexpansion, option 1 is your friend. diff --git a/docs/index.md b/docs/index.md index c18c2e7..b4f5524 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ {: style="width:300px; height: auto" , align=right } -This year's badge is the Tildagon badge. It's a hexagon with a slot on each side that you can plug _[hexpansions](#hexpansions)_ into. A hexpansion is a 1 mm thick object with a hexagon shape on one edge (a six-sided polygon like this: ⬡). It can be made of cardstock, so you can quickly add some cat ears to your badge, or it can be a printed circuit. +This year's badge is the Tildagon badge. It's a hexagon with a slot on each side that you can plug _[hexpansions](#hexpansions)_ into. A hexpansion is a 1 mm thick object with a hexagon shape on one edge (a six-sided polygon like this: ⬡). It can be made of card stock, so you can quickly add some cat ears to your badge, or it can be a printed circuit. Unlike in previous years, [Electromagnetic Field](https://www.emfcamp.org/) is trying to make a [longer-lasting platform](#a-reusable-platform-with-an-interchangeable-part) so any apps developed for it will work for multiple years. @@ -84,7 +84,7 @@ Hexpansions are accessories that plug into the badge's expansion connectors. Alm <span class="label">LED Filament hexpansion by John Thurmond</span> </span> <span class="img-container"> - <img src=" ../../images/hexpansions/makerspace.gif" loading="lazy" alt="Markerspace hexpansion" data-title="Maker Space badge by Dan" data-description=".custom-desc-makerspace"> + <img src=" ../../images/hexpansions/makerspace.gif" loading="lazy" alt="Makerspace hexpansion" data-title="Maker Space badge by Dan" data-description=".custom-desc-makerspace"> <span class="label"><a href="https://www.makerspace.org.uk/">Maker Space</a> badge by Dan</span> <div class="glightbox-desc custom-desc-makerspace"> <p>Link: <a href="https://www.makerspace.org.uk/">GitHub</a></p> @@ -144,7 +144,7 @@ Hexpansions are accessories that plug into the badge's expansion connectors. Alm <span class="label">Fidget Spinner by Catherine</span> </span> <span class="img-container collapsible collapsed"> - <img src=" ../../images/hexpansions/breadbeard.jpg" loading="lazy" alt="Breadbord hexpansion" data-title="Breadbeard Hexpansion by Danny Walker" data-description=""> + <img src=" ../../images/hexpansions/breadbeard.jpg" loading="lazy" alt="Breadbeard hexpansion" data-title="Breadbeard Hexpansion by Danny Walker" data-description=""> <span class="label">Breadbeard Hexpansion by Danny Walker</span> </span> <span class="img-container collapsible collapsed"> diff --git a/docs/tildagon-apps/examples/bitmaps.md b/docs/tildagon-apps/examples/bitmaps.md index 3279506..cc4999a 100644 --- a/docs/tildagon-apps/examples/bitmaps.md +++ b/docs/tildagon-apps/examples/bitmaps.md @@ -11,4 +11,3 @@ weight: 3 3. Import `tildagonos` with `from tildagonos import tildagonos` 4. Use `tildagonos.tft.bitmap(heartimage, 50, 50)`, replacing the `heartimage`, and the x and y values (`50`, `50`) with your desired values - _Found in [badge-2024-software](https://github.com/emfcamp/badge-2024-software/blob/86547c67cc232e2883dd9f5a4561d7c429c36df4/modules/gc9a01py.py)_ - - diff --git a/docs/tildagon-apps/examples/inter-badge-communications.md b/docs/tildagon-apps/examples/inter-badge-communications.md index 4f89b99..b16edfe 100644 --- a/docs/tildagon-apps/examples/inter-badge-communications.md +++ b/docs/tildagon-apps/examples/inter-badge-communications.md @@ -10,7 +10,7 @@ Broadcast functionality, which does not require the MAC address of a recipient, MAC address can be found through like so: -```python3 +```python import network import ubinascii @@ -22,5 +22,5 @@ mac_str = ubinascii.hexlify(wlan_mac).decode() print(f"MAC address: {mac_str}") ``` -[See the ESPNOW micropython docs for more information and inspiration](https://docs.micropython.org/en/latest/library/espnow.html). +[See the ESPNOW MicroPython docs for more information and inspiration](https://docs.micropython.org/en/latest/library/espnow.html). If you get broadcast working, please submit a PR on these docs with your solution. diff --git a/docs/tildagon-apps/index.md b/docs/tildagon-apps/index.md index 2a7dcbb..1b2481e 100644 --- a/docs/tildagon-apps/index.md +++ b/docs/tildagon-apps/index.md @@ -12,7 +12,7 @@ For more info check out [Write a Tildagon OS App][app-getting-started] or follow ## Publishing your app -You can publish your apps to the [app store](https://apps.badge.emfcamp.org/) so EMF2024 attendees can use them. For more info see [Publish your app](publish.md). +You can publish your apps to the [app store](https://apps.badge.emfcamp.org/) so EMF attendees can use them. For more info see [Publish your app](publish.md). [app-getting-started]: ./development.md diff --git a/docs/tildagon-apps/reference/ctx.md b/docs/tildagon-apps/reference/ctx.md index 6861ad0..bb1fb3c 100644 --- a/docs/tildagon-apps/reference/ctx.md +++ b/docs/tildagon-apps/reference/ctx.md @@ -148,7 +148,7 @@ Think of the `ctx` object as a canvas. The object stores the drawing state of th - `compositing_mode`: The current compositing mode. - `global_alpha`: The alpha (transparency) value that is applied to shapes and images before they are drawn onto the canvas. -You can `save()` the state of the canvas before drawing something on the canvas and `restore()` the state once you have finished drawing a special item. If for example you want to draw red squares and then draw one green square but don't want to have to respecify the entire state you can do this: +You can `save()` the state of the canvas before drawing something on the canvas and `restore()` the state once you have finished drawing a special item. If for example you want to draw red squares, and then draw one green square, but don't want to have to re-specify the entire state, you can do this: ```python import app diff --git a/docs/tildagon-apps/reference/ui-elements.md b/docs/tildagon-apps/reference/ui-elements.md index f5380ef..57f2918 100644 --- a/docs/tildagon-apps/reference/ui-elements.md +++ b/docs/tildagon-apps/reference/ui-elements.md @@ -635,7 +635,7 @@ You can use the following methods on a `TextDialog` object: ## Layouts -You can componse menu layouts out of the following display layouts: +You can compose menu layouts out of the following display layouts: - [`TextDisplay`](./#textdisplay): The `TextDisplay` component allows you to display long texts. - [`ButtonDisplay`](./#buttondisplay): The `ButtonDisplay` component allows you to display a button and register a handler for the button. diff --git a/docs/tildagon-apps/simple_tildagon.md b/docs/tildagon-apps/simple_tildagon.md index 4755ae1..400b41d 100644 --- a/docs/tildagon-apps/simple_tildagon.md +++ b/docs/tildagon-apps/simple_tildagon.md @@ -102,7 +102,7 @@ import time while True: # Options include is_tilted_left, is_tilted_right, - # is_tilted_foward, is_tilted_back + # is_tilted_forward, is_tilted_back if st.imu.is_tilted_left(): print("Left!") time.sleep(1) # Only checking every second @@ -132,7 +132,7 @@ import time while True: - # Options include is_tilted_left, is_tilted_right, is_tilted_foward, + # Options include is_tilted_left, is_tilted_right, is_tilted_forward, # is_tilted_back if st.button.get("A"): print("Button A is being pressed!") diff --git a/docs/tildagon-firmware/index.md b/docs/tildagon-firmware/index.md index b0b580c..a52fd19 100644 --- a/docs/tildagon-firmware/index.md +++ b/docs/tildagon-firmware/index.md @@ -2,7 +2,7 @@ Although hardware is complete and ordered for emfcamp 2024, the firmware is still in development. If you would like to get involved with writing the -micropython code that interfaces with badge hardware, provides programming +MicroPython code that interfaces with badge hardware, provides programming interfaces for apps, and provides a user interface, then please get in touch with the badge team. diff --git a/docs/using-the-badge/connect-to-wifi.md b/docs/using-the-badge/connect-to-wifi.md index d0a4a96..d0a4b95 100644 --- a/docs/using-the-badge/connect-to-wifi.md +++ b/docs/using-the-badge/connect-to-wifi.md @@ -48,7 +48,7 @@ Probably the simplest option is to open [Tildagon Flasher](https://emfcamp.githu settings.set('wifi_wpa2ent_username', None) ``` - Run the following commant to save the settings + Run the following command to save the settings ``` settings.save() @@ -94,7 +94,7 @@ Probably the simplest option is to open [Tildagon Flasher](https://emfcamp.githu settings.set('wifi_wpa2ent_username', None) ``` - Run the following commant to save the settings + Run the following command to save the settings ``` settings.save()