typos and markdown fixes

Author: laurent-martin

.technical.dict

@@ -0,0 +1,18 @@
+RTSP
+RTMP
+sysklogd
+bootloader
+UART
+bootable
+distro
+stopbit
+baudrate
+backfeeding
+Buildroot
+GPIO
+makefile
+makefiles
+defconfig
+rootfs
+ipctool
+ffplay

.vscode/settings.json

@@ -0,0 +1,19 @@
+{
+  "markdownlint.config": {
+    "default": true,
+    "MD003": false,
+    "MD009": false,
+    "MD007": { "indent": 2 },
+    "MD012": { "maximum": 2},
+    "MD022": false,
+    "MD026": { "punctuation": ",;!" },
+    "MD031": false,
+    "MD032": false,
+    "MD034": false,
+    "MD040": false,
+    "MD045": false,
+    "MD050": false,
+    "MD053": false,
+    "no-hard-tabs": false
+  }
+}

cspell.yaml

@@ -0,0 +1,24 @@
+version: "0.2"
+ignorePaths: []
+dictionaryDefinitions:
+  - name: technical
+    path: .technical.dict
+    addWords: true
+dictionaries:
+  - technical
+words: []
+import: []
+enableFiletypes:
+  - shellscript
+patterns:
+  - name: markdown_code_block
+    pattern: "/^\\s*```(.|\\n)+?^\\s*```/gm"
+  - name: markdown_code_inline
+    pattern: "/`[^`]*`/g"
+languageSettings:
+  - languageId: markdown
+    ignoreRegExpList:
+      - markdown_code_block
+      - markdown_code_inline
+      - "/[A-Z]*/g"
+ignoreWords: []

en/acme-v2.md

@@ -11,8 +11,9 @@ for that.
 ### Create an ACME account:
 
 __on camera:__
-```console
-$ uacme -y -v new
+
+```bash
+uacme -y -v new
 ```
 
 ### Give your camera a FQDN
@@ -24,20 +25,22 @@ be accessed over HTTPS.
 Create an account with any Domain Name Register and register a domain name, e.g. _mysuperduperdomain.com_.
 
 Set up a DNS zone for that domain name and create a record for your camera in that domain zone.
-```
+
+```console
 DNS Records
 mysuperduperdomain.com
 ---------------------------------------
 Type    Host       IP Address       TTL
 A       ipc-001    75.123.45.555    600
 ```
+
 where `75.123.45.555` is your public IP address.
 
 ### Set up port forwarding if your camera is behind NAT.
 
 Add port forwarding from port 80 of WAN interface to port 80 of your camera's local IP address.
 
-```
+```console
 75.123.45.555:80 => 192.168.1.10:80
 ```
 
@@ -47,19 +50,22 @@ camera domain name to HTTP proxy.
 ### Issue a certificate for your domain:
 
 __on camera__:
-```console
-$ uacme -y -v -h /usr/share/uacme/uacme.sh -t EC issue ipc-001.mysuperduperdomain.com
+
+```bash
+uacme -y -v -h /usr/share/uacme/uacme.sh -t EC issue ipc-001.mysuperduperdomain.com
 ```
 
 ### Set up a local DNS record override
 
 You can add an override record to `/etc/hosts` file on your machine
-```
+
+```bash
 echo "192.168.1.10  ipc-001.mysuperduperdomain.com" >> /etc/hosts
 ```
+
 or you could create a record on your local DNS server like [pi.hole](https://pi-hole.net/)
 so that anyone using that DNS server could have secure access to the camera, too.
 
 ### Restart majestic and test access
 
-Open your favorite web browser and go to https://ipc-001.mysuperduperdomain.com/
+Open your favorite web browser and go to <https://ipc-001.mysuperduperdomain.com/>

en/building.md

@@ -3,6 +3,9 @@ Building from sources
 
 Before you start building your own firmware, make a few changes to your system.
 
+General
+---
+
 ### Clone OpenIPC Firmware Git repository.
 ```
 cd
@@ -13,7 +16,8 @@ cd openipc-firmware
 ```
 
 ### Install required packages.
-```
+
+```bash
 sudo make install-deps
 ```
 
@@ -23,28 +27,30 @@ By default, Buildroot stores all downloaded files in `dl/` directory inside
 buildroot file tree.
 
 OpenIPC building script creates a fresh buildroot file tree before every
-compilation, meaning either deletes all dosnloaded packages or copies them back
+compilation, meaning either deletes all downloaded packages or copies them back
 and forth prior and after creating a fresh setup.
 
 You can set your own storage directory outside of the buildroot tree. Add the
 following piece of code to `.profile` file in your home directory:
-```
+
+```bash
 BR2_DL_DIR="${HOME}/buildroot_dl"
 [ ! -d "$BR2_DL_DIR" ] && mkdir -p $BR2_DL_DIR
 export BR2_DL_DIR
 ```
 
 Then, source the changes.
 
-```
+```bash
 source ~/.profile
 ```
 
 ### Build the firmware.
 
 Building of a binary firmware for your IP camera is fairly easy. Just clone
 source code from the repository and run a provided script.
-```
+
+```bash
 ./building.sh
 ```
 
@@ -67,14 +73,14 @@ depending on your computer performance and selected target. If you want to
 speed up the process, make sure you use a computer with SSD rather than HDD as
 the process of compiling involves a lot of reading and writing. Faster CPU is
 also beneficial, and one cannot have too much RAM, either. You could even rent
-an online virtual server for a handfull of cents to compile your firmware with
+an online virtual server for a handful of cents to compile your firmware with
 the power of cloud computing.
 
 The very first run is the longest as the script will download every source
 bundle required for successful compilation. Consequent runs will take a little
 less time.
 
-After the compilation is done, you'll find the final binary kernel and rootfs
+After the compilation is done, you'll find the final binary kernel and `rootfs`
 image in `output/images/` directory.
 
 ```
@@ -140,7 +146,7 @@ Making changes and rebuilding a package
 ---------------------------------------
 
 Once you start tinkering with the packages you'll realize you need a way to
-rebuld only one particular package, without rebuilding the whole project.
+rebuild only one particular package, without rebuilding the whole project.
 Is it even possible? Fortunately, yes. All you have to do after making changes
 to the package configs is to run a couple of commands:
 ```
@@ -156,14 +162,14 @@ the said package, and do not trigger re-creating the root filesystem image.
 If re-creating the root filesystem in necessary, one should in addition run
 `make br-all`.
 
-Run `make br-linux-rebuild br-all` to rebuild Linux kernel image, 
+Run `make br-linux-rebuild br-all` to rebuild Linux kernel image,
 `make br-busybox-rebuild br-all` to rebuild busybox and pack it into a rootfs image.
 
 Making changes to Buildroot packages
 ------------------------------------
 
-If you need to make a change to a package already supplied with Buildroot, 
-place your patches to `global/package/all-patches/<pkg-name>/` directory. 
+If you need to make a change to a package already supplied with Buildroot,
+place your patches to `global/package/all-patches/<pkg-name>/` directory.
 These patches will be added after Buildroot package is extracted and patches
 from Buildroot package applied.
 
@@ -185,7 +191,7 @@ Compilation process has also built a toolchain suitable for compiling packages
 for your version of firmware. The toolchain is located in `output/host`
 directory.
 
-To customize your firmware, add or remove a package run `make br-menuconfig`. 
+To customize your firmware, add or remove a package run `make br-menuconfig`.
 That will load buildroot configuration menu where you can make changes following
 [The Buildroot user manual][5]. Make your changes and save amended config on exit.
 Then run `make clean all`.

en/contribute.md

@@ -3,14 +3,17 @@
 
 > "Improving the world, one patch at a time."
 
+Guidelines
+---
+
 ### This is an open project, so you can help, too.
 
 We try to collect, organize and share as much information regarding different
 aspects of the project as we can. But sometimes we overlook things that seem
 obvious to us, developers, but are not so obvious to end-users, people who are
 less familiar with nuts and bolts behind the scene. That is why we set up this
 wiki and let anyone having a GitHub account to make additions and improvements
-to the knowledgebase.
+to the knowledge base.
 
 ### How to contribute.
 

en/dev-ffmpeg-usage.md

@@ -4,7 +4,7 @@
 FFMPEG, RTSP and SRT examples
 -----------------------------
 
-```
+```bash
 # Copy from file to file
 ./ffmpeg -re -i z_input.mp4 -c copy z_output.mp4
 

en/dev-tricks.md

@@ -5,7 +5,8 @@ Interesting tricks
 ------------------
 
 ### Sharing output of a command via web
-```
+
+```bash
 <command> | nc seashells.io 1337
 ```
 
@@ -108,4 +109,5 @@ index d64ff27..159336e 100644
  		G.logFileSize = xatou_range(opt_s, 0, INT_MAX/1024) * 1024;
 -- 
 ```
+
 _from [sysklogd: add -Z option to adjust message timezones](http://lists.busybox.net/pipermail/busybox/2017-May/085437.html)_

en/device-chacon-ipcam-ri01.md

@@ -80,7 +80,6 @@ At the bottom of the mainboard:
 ![device_chacon_ipcam-ri01_uart](https://user-images.githubusercontent.com/1659543/149518771-a33ab23f-a4f0-44db-83a6-873bd1802056.jpg)
 
 
-
 ### GPIOs
 
 | nr        | Description   |
@@ -517,7 +516,7 @@ sensors:
 ## Flashing OpenIPC
 (soon...)
 
-#### Boot dump
+### Boot dump
 ```
 Uncompress Ok!
 

en/device-wyze-integration.md

@@ -31,7 +31,7 @@ This is where we'll be writing down our guide to flashing new devices and report
 
 * Backup
 
-Downgrade original firmware version to (Jun 2021 w-o internet)demo_wcv3_4.36.2.5.bin 
+Downgrade original firmware version to (Jun 2021 w-o internet)demo_wcv3_4.36.2.5.bin
 [(WYom20200 Jun 2021 w-o internet)demo_wcv3_4.36.2.5.bin.zip](https://github.com/OpenIPC/wiki/files/10755387/WYom20200.Jun.2021.w-o.internet.demo_wcv3_4.36.2.5.bin.zip)
 
 Login with user `root` password `WYom20200` via telnet or UART console.
@@ -175,7 +175,7 @@ Erasing block: 8/8 (100%)
 Writing kb: 242/242 (100%) 
 Verifying kb: 242/242 (100%) 
 ```
-Now your camera flashed with OpenIPC U-boot, but whole system is still stock. 
+Now your camera flashed with OpenIPC U-boot, but whole system is still stock.
 So, next re/boot will load OpenIPC U-boot only (in cycling mode, until stop with `Ctrl+C` in UART console).
 
 * Flash kernel and rootfs
@@ -188,27 +188,31 @@ https://github.com/OpenIPC/firmware/releases/download/latest/openipc.t31-nor-lit
 
 Power off the camera.
 
-Extract and copy `rootfs.squashfs.t31` `uImage.t31` to microSD card. Insert microSD card in camera. 
+Extract and copy `rootfs.squashfs.t31` `uImage.t31` to microSD card. Insert microSD card in camera.
 
 Power on the camera.
 
-During power on the camera press `Ctrl+C` several times until it shows OpenIPC promt like this `OpenIPC # `
+During power on the camera press `Ctrl+C` several times until it shows OpenIPC prompt like this `OpenIPC #`
 
 Then issue command `run setnor16m`
 
 After you press the Enter key the camera will almost immediately restart and you will have to catch the prompt again.
 
-Then issue command 
+Then issue command:
 
-`mw.b ${baseaddr} ff 1000000; fatload mmc 0:1 ${baseaddr} uImage.${soc} ; sf probe 0; sf erase 0x50000 0x300000; sf write ${baseaddr} 0x50000 ${filesize}` 
+```bash
+mw.b ${baseaddr} ff 1000000; fatload mmc 0:1 ${baseaddr} uImage.${soc} ; sf probe 0; sf erase 0x50000 0x300000; sf write ${baseaddr} 0x50000 ${filesize}
+```
 
-and next 
+and next:
 
-`mw.b ${baseaddr} ff 1000000; fatload mmc 0:1 ${baseaddr} rootfs.squashfs.${soc} ; sf probe 0; sf erase 0x350000 0xa00000; sf write ${baseaddr} 0x350000 ${filesize}`
+```bash
+mw.b ${baseaddr} ff 1000000; fatload mmc 0:1 ${baseaddr} rootfs.squashfs.${soc} ; sf probe 0; sf erase 0x350000 0xa00000; sf write ${baseaddr} 0x350000 ${filesize}
+```
 
 Output sample:
 
-```
+```shell
 OpenIPC # mw.b ${baseaddr} ff 1000000; fatload mmc 0:1 ${baseaddr} uImage.${soc} ; sf probe 0; sf erase 0x50000 0x300000; sf write ${baseaddr} 0x50000 ${filesize}
 reading uImage.t31
 1855437 bytes read in 89 ms (19.9 MiB/s)
@@ -236,7 +240,7 @@ SF: 5079040 bytes @ 0x350000 Written: OK
 ```
 If everything went well, issue the command `reset` and camera should start boot OpenIPC.
 
-```
+```console
 Welcome to OpenIPC
 openipc-t31 login: root
 

en/equipment-flashing.md

@@ -9,7 +9,7 @@ Equipment for flashing
 While some hardened technicians would insist on getting things done
 with a grandfather's kilowatt soldering iron, we suggest you to buy
 a modern [soldering station with a hot air](https://www.aliexpress.com/premium/soldering-station-hot-air.html)
-and temperature control. You don't need to be fancy, an entry level 
+and temperature control. You don't need to be fancy, an entry level
 soldering station like YIHUA 882D, or JCD 8898, or YOUYUE 8586 would
 do, and it won't break the bank with its price tag of $50-70, more 
 or less.
@@ -19,8 +19,8 @@ or less.
 ![](../images/equipment-youyue8586.webp)
 
 Throw in a silicone mat, a tube of no-clean flux, a can of solder paste,
-desoldering copper wick, ceramic tweezers, nonwoven swabs and a bottle
-of isopropyl alcohol. Many of these things can be already included as 
+de-soldering copper wick, ceramic tweezers, nonwoven swabs and a bottle
+of isopropyl alcohol. Many of these things can be already included as
 perks with the soldering station.
 
 ### A programmer for flashing memory chips.