fix: change script code blocks to use sh instead of shell

apparently it is more widely supported in markdown renderers
pull/3281/head
yougotwill 3 months ago
parent fbd82b3b05
commit a314b46105

@ -38,7 +38,7 @@ If you use other python versions you might have or need a python version manager
> [!WARNING] > [!WARNING]
> The package [setuptools](https://pypi.org/project/setuptools/) was removed in Python 3.12, so you'll need to install it manually. > The package [setuptools](https://pypi.org/project/setuptools/) was removed in Python 3.12, so you'll need to install it manually.
```shell ```sh
pip install setuptools pip install setuptools
``` ```
@ -94,13 +94,13 @@ Setup instructions for Windows using Chocolatey:
- Install [Git](https://git-scm.com/download/win) - Install [Git](https://git-scm.com/download/win)
```shell ```sh
choco install git choco install git
``` ```
- Install [Git-LFS](https://git-lfs.com/) - Install [Git-LFS](https://git-lfs.com/)
```shell ```sh
choco install git-lfs choco install git-lfs
``` ```
@ -108,19 +108,19 @@ Setup instructions for Windows using Chocolatey:
CMake does not add itself to the system path by default, so you'll need specify the `ADD_CMAKE_TO_PATH` argument. CMake does not add itself to the system path by default, so you'll need specify the `ADD_CMAKE_TO_PATH` argument.
```shell ```sh
choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System' choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
``` ```
- Install [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) - Install [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)
```shell ```sh
choco install visualstudio2022community choco install visualstudio2022community
``` ```
- Install [Visual C++ build tools workload for Visual Studio 2022](https://community.chocolatey.org/packages/visualstudio2022-workload-vctools) - Install [Visual C++ build tools workload for Visual Studio 2022](https://community.chocolatey.org/packages/visualstudio2022-workload-vctools)
```shell ```sh
choco install visualstudio2022-workload-vctools choco install visualstudio2022-workload-vctools
``` ```
@ -132,7 +132,7 @@ Setup instructions for Windows using Chocolatey:
You can get the current `<version>` from the [`.nvmrc`](.nvmrc). You can get the current `<version>` from the [`.nvmrc`](.nvmrc).
```shell ```sh
choco install nodejs --version <version> choco install nodejs --version <version>
``` ```
@ -140,19 +140,19 @@ Setup instructions for Windows using Chocolatey:
You can get the current `<version>` from the [`.tool-versions`](.tool-versions). You can get the current `<version>` from the [`.tool-versions`](.tool-versions).
```shell ```sh
choco install python --version <version> choco install python --version <version>
``` ```
- Install [setuptools](https://pypi.org/project/setuptools/) - Install [setuptools](https://pypi.org/project/setuptools/)
```shell ```sh
pip install setuptools pip install setuptools
``` ```
- Install [Yarn Classic](https://classic.yarnpkg.com/en/docs/install/#windows-stable) - Install [Yarn Classic](https://classic.yarnpkg.com/en/docs/install/#windows-stable)
```shell ```sh
npm install --global yarn npm install --global yarn
``` ```
@ -166,7 +166,7 @@ Setup instructions for Windows using Chocolatey:
- Install build tools (this installs make, g++, gcc). - Install build tools (this installs make, g++, gcc).
```shell ```sh
apt install build-essential cmake apt install build-essential cmake
``` ```
@ -174,14 +174,14 @@ apt install build-essential cmake
- In Ubuntu, you may also need to install - In Ubuntu, you may also need to install
```shell ```sh
sudo apt install cmake sudo apt install cmake
npm install cmake-js npm install cmake-js
``` ```
- In Fedora, you may also need to install - In Fedora, you may also need to install
```shell ```sh
sudo dnf install make automake gcc gcc-c++ kernel-devel sudo dnf install make automake gcc gcc-c++ kernel-devel
``` ```
@ -189,7 +189,7 @@ sudo dnf install make automake gcc gcc-c++ kernel-devel
Now, run these commands in your preferred terminal in a good directory for development: Now, run these commands in your preferred terminal in a good directory for development:
```shell ```sh
git clone https://github.com/session-foundation/session-desktop.git git clone https://github.com/session-foundation/session-desktop.git
cd session-desktop cd session-desktop
npm install --global yarn # (only if you dont already have `yarn`) npm install --global yarn # (only if you dont already have `yarn`)
@ -208,7 +208,7 @@ is no automatic restart mechanism for the entire application.
You can keep the developer tools open (`View > Toggle Developer Tools`) and press <kbd>Cmd</kbd> + <kbd>R</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>R</kbd> (Windows & Linux) to reload the application frontend. You can keep the developer tools open (`View > Toggle Developer Tools`) and press <kbd>Cmd</kbd> + <kbd>R</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>R</kbd> (Windows & Linux) to reload the application frontend.
```shell ```sh
# runs until you stop it, re-generating built assets on file changes. # runs until you stop it, re-generating built assets on file changes.
# Once this command is waiting for changes, you will need to run in another terminal `yarn build:workers` to fix the "exports undefined" error on start. # Once this command is waiting for changes, you will need to run in another terminal `yarn build:workers` to fix the "exports undefined" error on start.
@ -240,14 +240,14 @@ This user profile folder will change directories from `[PROFILE_PATH]/Session-{e
There are a few scripts which you can use: There are a few scripts which you can use:
```shell ```sh
yarn start-prod # Start production but in development mode yarn start-prod # Start production but in development mode
MULTI=1 yarn start-prod # Start another instance of production MULTI=1 yarn start-prod # Start another instance of production
``` ```
For more than 2 clients, you may run the above command with `MULTI` set before them. For example, running: For more than 2 clients, you may run the above command with `MULTI` set before them. For example, running:
```shell ```sh
MULTI=alice yarn start-prod MULTI=alice yarn start-prod
``` ```
@ -338,7 +338,7 @@ see how they did things.
You can build a production binary by running the following: You can build a production binary by running the following:
```shell ```sh
yarn build-everything yarn build-everything
yarn build-release yarn build-release
``` ```

@ -22,7 +22,7 @@ Once you have your `Developer ID Application` you need to export it into a `.p12
We need to Base64 encode this file, so run the following command: We need to Base64 encode this file, so run the following command:
```shell ```sh
base64 -i certificate.p12 -o encoded.txt base64 -i certificate.p12 -o encoded.txt
``` ```
@ -53,11 +53,11 @@ Follow the instructions in [Contributing.md](CONTRIBUTING.md) to set up your dev
The [rpm](https://rpm.org) package is required for running the build-release script on Linux. Run the appropriate command to install the `rpm` package: The [rpm](https://rpm.org) package is required for running the build-release script on Linux. Run the appropriate command to install the `rpm` package:
```shell ```sh
sudo pacman -S rpm # Arch sudo pacman -S rpm # Arch
``` ```
```shell ```sh
sudo apt install rpm # Ubuntu/Debian sudo apt install rpm # Ubuntu/Debian
``` ```
@ -72,7 +72,7 @@ You will also need an [App-specific password](https://support.apple.com/en-al/HT
Then run the following to export the variables Then run the following to export the variables
```shell ```sh
export SIGNING_APPLE_ID=<your apple id> export SIGNING_APPLE_ID=<your apple id>
export SIGNING_APP_PASSWORD=<your app specific password> export SIGNING_APP_PASSWORD=<your app specific password>
export SIGNING_TEAM_ID=<your team id if applicable> export SIGNING_TEAM_ID=<your team id if applicable>
@ -84,7 +84,7 @@ export SIGNING_TEAM_ID=<your team id if applicable>
Once your development environment is set up, here are the steps to build the application: Once your development environment is set up, here are the steps to build the application:
```shell ```sh
yarn install --frozen-lockfile # install all dependencies of this project yarn install --frozen-lockfile # install all dependencies of this project
yarn build-everything # transpile and assemble files yarn build-everything # transpile and assemble files
yarn build-release yarn build-release

@ -34,7 +34,7 @@ Want to help us translate Session into your language? You can do so at https://g
Add Jason's GPG key. Jason Rhinelander, a member of the [Session Technology Foundation](https://session.foundation/) and is the current signer for all Session Desktop releases. His GPG key can be found on his GitHub and other sources. Add Jason's GPG key. Jason Rhinelander, a member of the [Session Technology Foundation](https://session.foundation/) and is the current signer for all Session Desktop releases. His GPG key can be found on his GitHub and other sources.
```shell ```sh
wget https://github.com/jagerman.gpg wget https://github.com/jagerman.gpg
gpg --import jagerman.gpg gpg --import jagerman.gpg
``` ```
@ -43,7 +43,7 @@ gpg --import jagerman.gpg
Get the signed hashes for this release. `SESSION_VERSION` needs to be updated for the release you want to verify. Get the signed hashes for this release. `SESSION_VERSION` needs to be updated for the release you want to verify.
```shell ```sh
export SESSION_VERSION=1.15.0 export SESSION_VERSION=1.15.0
wget https://github.com/session-foundation/session-desktop/releases/download/v$SESSION_VERSION/signature.asc wget https://github.com/session-foundation/session-desktop/releases/download/v$SESSION_VERSION/signature.asc
``` ```
@ -52,7 +52,7 @@ wget https://github.com/session-foundation/session-desktop/releases/download/v$S
Verify the signature of the hashes of the files. Verify the signature of the hashes of the files.
```shell ```sh
gpg --verify signature.asc 2>&1 |grep "Good signature from" gpg --verify signature.asc 2>&1 |grep "Good signature from"
``` ```
@ -65,7 +65,7 @@ Make sure the two commands below return the same hash for the file you are check
<details> <details>
<summary>Linux</summary> <summary>Linux</summary>
```shell ```sh
sha256sum session-desktop-linux-amd64-$SESSION_VERSION.deb sha256sum session-desktop-linux-amd64-$SESSION_VERSION.deb
grep .deb signature.asc grep .deb signature.asc
``` ```
@ -77,14 +77,14 @@ grep .deb signature.asc
**Apple Silicon** **Apple Silicon**
```shell ```sh
sha256sum releases/session-desktop-mac-arm64-$SESSION_VERSION.dmg sha256sum releases/session-desktop-mac-arm64-$SESSION_VERSION.dmg
grep .dmg signature.asc grep .dmg signature.asc
``` ```
**Intel** **Intel**
```shell ```sh
sha256sum releases/session-desktop-mac-x64-$SESSION_VERSION.dmg sha256sum releases/session-desktop-mac-x64-$SESSION_VERSION.dmg
grep .dmg signature.asc grep .dmg signature.asc
``` ```
@ -103,7 +103,7 @@ Select-String -Pattern ".exe" signature.asc
**Bash** **Bash**
```shell ```sh
sha256sum session-desktop-win-x64-$SESSION_VERSION.exe sha256sum session-desktop-win-x64-$SESSION_VERSION.exe
grep .exe signature.asc grep .exe signature.asc
``` ```

Loading…
Cancel
Save