Skip to content

Commit 3545e45

Browse files
authored
chore: Update README file to update commands and make it copy-paste friendly (#929)
1 parent 752d524 commit 3545e45

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ their IPC:
5353

5454
### 1. Clone repo
5555

56-
```bash
56+
```shell
5757
git clone https://github.com/aws/amazon-q-for-command-line.git
5858
```
5959

@@ -63,21 +63,21 @@ This is all the dep
6363

6464
For Debian/Ubuntu:
6565

66-
```bash
66+
```shell
6767
sudo apt update
6868
sudo apt install build-essential pkg-config jq dpkg curl wget cmake clang libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev libdbus-1-dev libwebkit2gtk-4.1-dev libjavascriptcoregtk-4.1-dev valac libibus-1.0-dev libglib2.0-dev sqlite3 libxdo-dev protobuf-compiler
6969
```
7070

7171
For Arch:
7272

73-
```bash
73+
```shell
7474
sudo pacman -Syu
7575
sudo pacman -S --needed webkit2gtk base-devel curl wget openssl appmenu-gtk-module gtk3 libappindicator-gtk3 librsvg libvips cmake jq pkgconf
7676
```
7777

7878
For Fedora:
7979

80-
```bash
80+
```shell
8181
sudo dnf check-update
8282
sudo dnf install webkit2gtk3-devel.x86_64 openssl-devel curl wget libappindicator-gtk3 librsvg2-devel jq
8383
sudo dnf group install "C Development Tools and Libraries"
@@ -95,30 +95,38 @@ brew install mise pnpm protobuf zsh bash fish shellcheck jq
9595
```shell
9696
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
9797
rustup default stable
98-
# for pre-commit hooks the two following commands are required
98+
```
99+
100+
For pre-commit hooks, the following commands are required:
101+
102+
```shell
99103
rustup toolchain install nightly
100104
cargo install typos-cli
101105
```
102106

103107
For MacOS development make sure the right targets are installed:
104108

105-
```bash
109+
```shell
106110
rustup target add x86_64-apple-darwin
107111
rustup target add aarch64-apple-darwin
108112
```
109113

110114
### 3. Setup Python and Node using [`mise`](https://mise.jdx.dev)
111115

112-
Add mise integrations to your shell shell
116+
Add mise integrations to your shell:
113117

118+
For zsh:
114119
```shell
115-
# zsh
116120
echo 'eval "$(mise activate zsh)"' >> "${ZDOTDIR-$HOME}/.zshrc"
121+
```
117122

118-
# bash
123+
For bash:
124+
```shell
119125
echo 'eval "$(mise activate bash)"' >> ~/.bashrc
126+
```
120127

121-
# fish
128+
For fish:
129+
```shell
122130
echo 'mise activate fish | source' >> ~/.config/fish/config.fish
123131
```
124132

@@ -131,9 +139,10 @@ mise install
131139

132140
### 4. Setup precommit hooks
133141

142+
Run `pnpm` in root directory to add pre-commit hooks:
143+
134144
```shell
135-
# Run `pnpm` in root directory to add pre-commit hooks
136-
pnpm install --ignore-scripts && pnpm husky install
145+
pnpm install --ignore-scripts
137146
```
138147

139148
## Security

0 commit comments

Comments
 (0)