diff --git a/meshterm/assets/pages/about.md b/meshterm/assets/pages/about.md index 577a1be..2421a1a 100644 --- a/meshterm/assets/pages/about.md +++ b/meshterm/assets/pages/about.md @@ -6,9 +6,9 @@ **MeshTerm** is a full-featured **MeshCore** client that lives in your terminal. Plug in a companion device over USB, pair one over Bluetooth, or reach one over TCP. Windows, macOS, and Linux. Free and open-source. -Nearly everything MeshTerm can do thru its interactive Text-based User Interface *(TUI)*, it can also do from the Command-Line Interface *(CLI)*. The live pictures stay in the TUI, where they belong — the map, the dashboard, the live feed, the watchtower, the mesh walk — and everything else has a command. The TUI runs the same code as the CLI, so you get the best of both worlds: a great user experience, and the ability to script or schedule tasks! Every command prints for a person by default, and speaks JSON with `--json` when a program is reading! +Nearly everything MeshTerm can do through its interactive Text-based User Interface *(TUI)*, it can also do from the Command-Line Interface *(CLI)*. The live pictures stay in the TUI, where they belong — the map, the dashboard, the live feed, the watchtower, the mesh walk — and everything else has a command. The TUI runs the same code as the CLI, so you get the best of both worlds: a great user experience, and the ability to script or schedule tasks! Every command prints for a person by default, and speaks JSON with `--json` when a program is reading! -Everything the radio overhears is recorded to a local database from the moment it's turned on — adverts, telemetry, signal quality, positions, etc. Features like maps, dashboard, and route graphs read back from it, so the longer it runs, the more it know about the mesh! +While MeshTerm is running and connected to your radio, everything the radio overhears is recorded to a local database — adverts, telemetry, signal quality, positions, etc. Features like maps, dashboard, and route graphs read back from it, so the longer it runs, the more it knows about the mesh! ## Where it came from @@ -18,29 +18,29 @@ I wanted something I could run from my computer. I wanted it to run on Windows, ## Platform-specific developments -In addition to generic Terminal setup, I wanted it to run on two devices I had lying around on my nerdcave. +In addition to a generic terminal setup, I wanted it to run on two devices I had lying around in my nerdcave. -### Clockwork uConsole -MeshTerm is compatible with the **HackerGadgets AIO board v1**. The **AIO** board has just a raw LoRa radio, meaning it can't run MeshCore firmware. MeshTerm includes a script to run the mesh node in software, and expose it using a TCP port which MeshTerm can connect to. +### ClockworkPi uConsole +MeshTerm is compatible with the **HackerGadgets AIO board (v1 or v2)**. The **AIO** board has just a raw LoRa radio, meaning it can't run MeshCore firmware. MeshTerm includes a script to run the mesh node in software, and expose it using a TCP port which MeshTerm can connect to. MeshTerm feels right at home on the **uConsole**. Running MeshTerm on it makes it feel like a piece of gear straight out of a William Gibson novel. -### Clockwork PicoCalc +### ClockworkPi PicoCalc Getting MeshTerm to run on the **PicoCalc** is a bit more involved, but totally worth it: - Swap out the **Raspberry Pi Pico** for a **Luckfox Lyra** to run **Calculinux**. -- Add a compatible 3.3v USB wifi dongle (e.g.: **TP-Link TL-WN725N N150 Nano**) to the **Lyra**'s internal USB port. -- Add a LoRa device. Here's a few options: +- Add a compatible 3.3 V USB Wi-Fi dongle (e.g. **TP-Link TL-WN725N N150 Nano**) to the **Lyra**'s internal USB port. +- Add a LoRa device. Here are two options: - Connect a companion via USB-C; - add **Seeed Studio XIAO nRF52840 + Wio-SX1262** internally, soldered to GPIO connectors' legs. -- In order to use the XIAO nRF52840 via GPIO, we do need to use a modified firmware. A **PR** *https://github.com/meshcore-dev/MeshCore/pull/3191* has been submitted to MeshCore, but it might take a while for it to go through. +- In order to use the XIAO nRF52840 via GPIO, a modified firmware is needed. A **PR** *https://github.com/meshcore-dev/MeshCore/pull/3191* has been submitted to MeshCore, but it might take a while for it to go through. -The UX is a bit different on the the PicoCalc's 16-color 53-column screen layout, but it's been tailored to make good use of the available space and the PicoCalc's F-keys. The result is, in my humble opinion, the best MeshCore experience you can get on a portable device. With two 18650 batteries, it'll run all day. +The UX is a bit different on the PicoCalc's 16-colour 53-column screen layout, but it's been tailored to make good use of the available space and the PicoCalc's F-keys. The result is, in my humble opinion, the best MeshCore experience you can get on a portable device. It runs on one 18650 battery, and a second one roughly doubles the runtime. ## What the future holds -MeshTerm will evolve over time, it is a work in progress. +MeshTerm will evolve over time. It is a work in progress. -I've build MeshTerm for myself — I find that's when I produce my best work — but I sincerely hope it will be appreciated by others. +I've built MeshTerm for myself — I find that's when I produce my best work — but I sincerely hope it will be appreciated by others. If you'd like a specific feature, pitch your idea on the Discord! @@ -49,9 +49,9 @@ If you'd like a specific feature, pitch your idea on the Discord! MeshTerm ships under the **Apache License, Version 2.0** — free to use, change, and redistribute, commercially or otherwise, as long as the LICENSE and NOTICE files travel with it. The full terms: -**apache.org/licenses/LICENSE-2.0** *https://www.apache.org/licenses/LICENSE-2.0*. +*https://www.apache.org/licenses/LICENSE-2.0*. -The licence covers the code, not the name: **MeshTerm and its logo are +The licence does not cover the name: **MeshTerm and its logo are trademarks the author keeps**, so a fork goes out under a name of its own. The donate link in this app supports this project and its original author — a fork that keeps soliciting through it, without pointing it at diff --git a/meshterm/assets/pages/author.md b/meshterm/assets/pages/author.md index 7dd4343..edc3e27 100644 --- a/meshterm/assets/pages/author.md +++ b/meshterm/assets/pages/author.md @@ -1,7 +1,7 @@ ## Who am I IRL -I'm Jean-Pierre Martineau. I live in Montréal, Québec, Canada. +I'm Jean-Pierre Martineau. I live in Montréal, Québec, Canada. -Data expert by day and tinkerer by night, I've spend my career designing solutions and writing code for various industries, from video-games to public transit. I've always had an unquenchable curiosity that drove me to pursue personal projects during my free time. MeshCore has been the focal point of my nights and weekends as of lately. +Data expert by day and tinkerer by night, I've spent my career designing solutions and writing code for various industries, from video games to public transit. I've always had an unquenchable curiosity that drove me to pursue personal projects during my free time. MeshCore has been the focal point of my nights and weekends lately. ## Who am I on the mesh @@ -9,11 +9,11 @@ I operate **YUL-Cartierville** and **YUL-Upper-Salaberry** repeaters in Montréa ## On the subject of AI assisted development -As a computer scientist, I find AI to be a powerful amplifier, not a substitute—of one's capabilities. For me, it's been a vector of productivity, allowing me to grasp something which would have been out of reach. I can spend my time ideating and let the machine take care of the nitty-gritty. Don't be fooled, sculpting MeshTerm into its current form still took a *lot* of work. Every nook and cranny of the app has been designed, tested, and iterated by me. Hundreds of hours of my own time, augmented by what I learned throughout my sofware developer career. +As a computer scientist, I find AI to be a powerful amplifier of one's capabilities. For me, it's been a vector of productivity, allowing me to grasp something which would have been out of reach. I can spend my time ideating and let the machine take care of the nitty-gritty. Don't be fooled: sculpting MeshTerm into its current form still took a *lot* of work. Every nook and cranny of the app has been designed, tested, and iterated by me. It took hundreds of hours of my own time, augmented by what I learned throughout my software developer career. MeshTerm would *not* exist without the use of AI tools. -One detail: the about pages were hand-written by me, and the ANSI art splash screen logo was done by hand — no AI — using **Moebius**. +One detail: these pages were hand-written by me, and the ANSI art splash screen logo was done by hand — no AI — using **Moebius**. ## How to reach me diff --git a/meshterm/assets/pages/support.md b/meshterm/assets/pages/support.md index 097039e..179c373 100644 --- a/meshterm/assets/pages/support.md +++ b/meshterm/assets/pages/support.md @@ -1,14 +1,14 @@ ## Why it needs support -**MeshTerm** is free. +**MeshTerm** is free and open source, and it will stay that way. The project is a labour of love. I've poured hundreds of hours of my free time into it. Evenings, late nights, weekends, even some of my vacation time! -As I mentionned in the about pages, this project relies on AI tools to accelerate development. Without them, MeshTerm would absolutely not exist. Subscriptions to these AI tools are a recurring expense! +As I mentioned on the Author page, this project relies on AI tools to accelerate development. Without them, MeshTerm would absolutely not exist. Subscriptions to these AI tools are a recurring expense! -Routers, companion devices, handhelds, antennas, and batteries aren't super expensive individually, but it all adds up quickly! +Repeaters, companion devices, handhelds, antennas, and batteries aren't super expensive individually, but it all adds up quickly! -If you want pitch in and contribute financially, you're more that welcome to do so. Any help will be greatly appreciated and put to good use. +If you want to pitch in and contribute financially, you're more than welcome to do so. Any help will be greatly appreciated and put to good use. ## Chip in @@ -20,7 +20,7 @@ If you want pitch in and contribute financially, you're more that welcome to do https://buymeacoffee.com/johnputer ``` -### Donate via Paypal +### Donate via PayPal - *https://www.paypal.com/donate/?hosted_button_id=5RATNEJP2K5U6* @@ -30,17 +30,17 @@ https://www.paypal.com/donate/?hosted_button_id=5RATNEJP2K5U6 ### Become a patron -- *https://www.patreon.com/c/MeshTerm* +- *https://www.patreon.com/cw/MeshTerm* ```qr -https://www.patreon.com/c/MeshTerm +https://www.patreon.com/cw/MeshTerm ``` ## Other ways to help - Spread the word and let others know how awesome **MeshTerm** is! - Join the Discord community! -- Give this project a Star **⭐** on **GitHub**! +- Give this project a Star **⭐** on **GitHub**! - Open an issue on **GitHub** when you encounter a bug or problem! *https://github.com/jpmartineau/MeshTerm*