From c709995e16a4766bff795ddf7183dc4462f36fc5 Mon Sep 17 00:00:00 2001 From: Malix Date: Tue, 27 Aug 2024 06:42:29 +0200 Subject: [PATCH] Enhance: shell markdown (#64) * Enhance: shell markdown * fix: from `.` to `sh` --- readme.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/readme.md b/readme.md index 80db4a6..0888a3a 100644 --- a/readme.md +++ b/readme.md @@ -92,10 +92,10 @@ aren't required. ## 3.1 MacOS -```bash +```sh # Disable warnings as error, these warning are from the CppRestSdk dependency -$ cmake . -G Ninja -D CMAKE_CXX_FLAGS="-w" -$ ninja GetIt +cmake . -G Ninja -D CMAKE_CXX_FLAGS="-w" +ninja GetIt ``` This will create the `./bin/GetIt.app` file. This can be executed by double-clicking it in Finder. @@ -111,9 +111,9 @@ The following steps have not been tested yet, if you follow these steps, and it to remove this warning. If these steps don't work, and you've got a working solution. Please also open a PR to include your steps here. -```bash -$ cmake . -G Ninja -$ ninja GetIt +```sh +cmake . -G Ninja +ninja GetIt ``` This will create the `./bin/GetIt` binary file. It can be executed by either running `./bin/GetIt` from the terminal @@ -127,9 +127,9 @@ The following steps have not been tested yet, if you follow these steps, and it to remove this warning. If these steps don't work, and you've got a working solution. Please also open a PR to include your steps here. -```bash -$ cmake . -G Ninja -$ ninja GetIt +```sh +cmake . -G Ninja +ninja GetIt ``` This will create the `./bin/GetIt.exe` executable. It can be executed by double-clicking the file from Explorer. @@ -141,8 +141,8 @@ This will create the `./bin/GetIt.exe` executable. It can be executed by double- Build the MacOS app bundle with all dependencies and framework included by running the `package.sh` script in the MacOS packaging folder. -```bash -$ zsh ./packaging/macos/package.sh +```sh +sh ./packaging/macos/package.sh ``` This will create the `./bin/GetIt.app` app bundle with all required dependencies. This file can be distributed across @@ -164,12 +164,12 @@ a PR or when directly pushing to the main branch (which should __NEVER__ be done To execute these tests manually you need to specify the `getit_tests` build target. -```bash -$ cmake . -G Ninja -$ ninja getit_tests +```sh +cmake . -G Ninja +ninja getit_tests # Execute the test cases -$ ./bin/getit_tests +./bin/getit_tests ``` This will generate an application that will test GetIt when executed.