Skip to content

Commit

Permalink
docs: change "console" markdown syntax to "shell" (#304)
Browse files Browse the repository at this point in the history
Oranda doesn't know how to highlight "console", it does know how to
highlight "shell":

```
  esp32c3-buddy ⚠ >o_o< WARNING: Found syntax highlight language annotation `console` which is not currently supported. The annotated block will be shown as plaintext. Please file an issue https://github.com/axodotdev/oranda/issues/new to let us know you'd like to see it supported.
  esp32c3-buddy ⚠ >o_o< WARNING: Found syntax highlight language annotation `console` which is not currently supported. The annotated block will be shown as plaintext. Please file an issue https://github.com/axodotdev/oranda/issues/new to let us know you'd like to see it supported.
  esp32c3-buddy ⚠ >o_o< WARNING: Found syntax highlight language annotation `console` which is not currently supported. The annotated block will be shown as plaintext. Please file an issue https://github.com/axodotdev/oranda/issues/new to let us know you'd like to see it supported.
  esp32c3-buddy ⚠ >o_o< WARNING: Found syntax highlight language annotation `console` which is not currently supported. The annotated block will be shown as plaintext. Please file an issue https://github.com/axodotdev/oranda/issues/new to let us know you'd like to see it supported.
  esp32c3-buddy ⚠ >o_o< WARNING: Found syntax highlight language annotation `console` which is not currently supported. The annotated block will be shown as plaintext. Please file an issue https://github.com/axodotdev/oranda/issues/new to let us know you'd like to see it supported.
  ```

GitHub's Markdown renderer treats these as equivalent, so switching the
code blocks currently marked as "console" to "shell" results in much
nicer syntax highlighting in the Oranda site without changing the way
the READMEs look on GitHub.
  • Loading branch information
hawkw committed Jan 19, 2024
1 parent 87c78eb commit 3b45e2b
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions platforms/allwinner-d1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The simplest way to build a MnemOS image for an Allwinner D1 board is to use the
The `just build-d1` recipe takes an optional argument to select which bin target
is built; by default, the `mq-pro` bin target is selected. For example:

```console
```shell
$ just build-d1 # builds MnemOS for the MangoPi MQ Pro
$ just build-d1 mq-pro # also builds MnemOS for the MQ Pro
$ just build-d1 lichee-rv # builds MnemOS for the Lichee RV
Expand All @@ -53,7 +53,7 @@ $ just build-d1 lichee-rv # builds MnemOS for the Lichee RV
Alternatively, Allwinner D1 images can be built manually using Cargo. To build
using Cargo, run the following commands:

```console
```shell
# set which board binary to build
$ export BOARD="mq-pro" # or "lichee-rv"

Expand Down Expand Up @@ -82,7 +82,7 @@ none is provided.

For example, running `just flash-d1 mq-pro` should print output like this:

```console
```shell
$ just flash-d1 mq-pro
Found cargo objcopy
Compiling mnemos-d1 v0.1.0 (/home/eliza/Code/mnemos/platforms/allwinner-d1/boards)
Expand Down
10 changes: 5 additions & 5 deletions platforms/esp32c3-buddy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ pin assignment to match the target devboard before calling into shared code:
The `just build-c3` recipe takes a required argument to select which bin target
is built. For example:

```console
```shell
$ just build-c3 qtpy # builds MnemOS for the Adafruit QT Py ESP32-C3
$ just build-c3 xiao # builds MnemOS for the Seeedstudio XIAO ESP32-C3
```

Alternatively, Allwinner D1 images can be built manually using Cargo. To build
using Cargo, run:

```console
```shell
# builds MnemOS for the Adafruit QT Py ESP32-C3
$ cargo build -p mnemos-esp32c3-buddy --bin qtpy --release
# builds MnemOS for the Seeedstudio XIAO ESP32-C3
Expand All @@ -61,7 +61,7 @@ anywhere in the MnemOS repository.

Like `just build-c3`, the target board must be provided:

```console
```shell
$ just flash-c3 qtpy # build and flash the Adafruit QT Py ESP32-C3
$ just flash-c3 xiao # build and flash the Seeedstudio XIAO ESP32-C3
```
Expand All @@ -74,7 +74,7 @@ $ just flash-c3 xiao # build and flash the Seeedstudio XIAO ESP32-C3
If everything worked successfully, you should see output similar to this:

```console
```shell
$ just flash-c3 qtpy
Found cargo-espflash
cargo build --package mnemos-esp32c3-buddy --bin qtpy --release
Expand All @@ -98,7 +98,7 @@ App/part. size: 209,760/4,128,768 bytes, 5.08%

Alternatively, the board can be flashed manually using [`cargo-espflash`]. For
example:
```console
```shell
$ cargo espflash flash \
--package mnemos-esp32c3-buddy \
--bin qtpy \ # or 'xiao'
Expand Down
2 changes: 1 addition & 1 deletion platforms/x86_64/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ MnemOS can boot using either legacy [BIOS] or [UEFI] (using [`ovmf-prebuilt`]).
The `--boot` argument can be passed to `just run-x86` to determine which boot
method is used:

```console
```shell
$ just run-x86 --boot uefi # boots using UEFI
$ just run-x86 --boot bios # boots using legacy BIOS
```
Expand Down
2 changes: 1 addition & 1 deletion tools/manganese/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ yes, this is a wildly deranged idea. i'm so smart.
invoking `cargo mn` without a subcommand will print a list of available
commands, which will look sort of like this:

```console
```shell
$ cargo mn
Compiling manganese v0.1.0 (/home/eliza/Code/mnemos/tools/manganese)
Finished release [optimized + debuginfo] target(s) in 3.99s
Expand Down

0 comments on commit 3b45e2b

Please sign in to comment.