Skip to content

Commit 4451f08

Browse files
committed
chore: updated grammar
1 parent b2601b2 commit 4451f08

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

Diff for: docs/tutorials/polykey-cli/installation.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -34,34 +34,36 @@ Download the executable named `...-polykey-cli-V.V.V-linux-x64`, and rename it t
3434
Make it executable:
3535

3636
```sh
37-
chmod u+x ./polykey
37+
$ chmod u+x ./polykey
3838
```
3939

4040
### Add it to your `$PATH`.
4141

4242
#### For ZSH:
4343

4444
1. `cd` into directory where polykey exec is stored.
45-
2. Edit the zsh config to add polykey to your path, to streamline the process, run the following command making sure to change the path to polykey if the polykey executable is not in the downloads folder.
46-
3. For most users, this would be `~/downloads` on Debian based systems.
45+
2. Edit the zsh config to add polykey to your path. To streamline the process, run the following command, making sure to change the path to polykey if the polykey executable is not in the downloads folder.
46+
3. For most users, this would be `~/Downloads`
4747

4848
:::warning
4949

5050
Make sure your path to the polykey executable is correct.
5151

5252
:::
5353

54-
```SH
55-
echo 'export PATH=~/downloads/polykey:$PATH' >> ~/.zshrc && source ~/.zshrc
54+
```sh
55+
$ echo 'export PATH=~/Downloads/polykey:$PATH' >> ~/.zshrc && source ~/.zshrc
5656
```
5757

58-
You can now run it with `polykey`.
58+
You only need to run this command once. After running this command, you can now invoke polykey by typing `polykey` into the terminal.
5959

6060
---
6161

6262
#### For Bash:
6363

64-
1. If you're using Bash, run the following command to add polykey to your path. Ensure to change the path if the executable is not in the downloads folder. For most users, this would be `~/downloads` on Debian-based systems.
64+
1. `cd` into directory where polykey exec is stored.
65+
2. Edit the zsh config to add polykey to your path. To streamline the process, run the following command, making sure to change the path to polykey if the polykey executable is not in the downloads folder.
66+
3. For most users, this would be `~/Downloads`
6567

6668
:::warning
6769

@@ -70,35 +72,35 @@ Make sure your path to the polykey executable is correct.
7072
:::
7173

7274
```sh
73-
echo 'export PATH=~/downloads/polykey:$PATH' >> ~/.bashrc && source ~/.bashrc
75+
$ echo 'export PATH=~/Downloads/polykey:$PATH' >> ~/.bashrc && source ~/.bashrc
7476
```
7577

76-
You can now run it with `polykey`.
78+
You only need to run this command once. After running this command, you can now invoke polykey by typing `polykey` into the terminal.
7779

7880
---
7981

8082
### NixOS
8183

82-
We have not yet published a Nixpkgs expression for Polykey. When we do, you will be able to just install `polykey-cli` from Nixpkgs.
84+
We have not yet published a Nix package for Polykey. When we do, you will be able to just install `polykey-cli` from Nixpkgs.
8385

84-
However it is easy enough to install it from source.
86+
However, it is easy enough to install it from source.
8587

8688
Clone the repository:
8789

8890
```sh
89-
git clone https://github.com/MatrixAI/Polykey-CLI.git
91+
$ git clone https://github.com/MatrixAI/Polykey-CLI.git
9092
```
9193

9294
Enter the `nix-shell`:
9395

9496
```sh
95-
nix-shell
97+
$ nix-shell
9698
```
9799

98100
Build the application and install it into the user profile:
99101

100102
```sh
101-
nix-env -f ./release.nix --install --attr application --argstr npmDepsHash "$(prefetch-npm-deps ./package-lock.json)"
103+
$ nix-env -f ./release.nix --install --attr application --argstr npmDepsHash "$(prefetch-npm-deps ./package-lock.json)"
102104
```
103105

104106
### Other
@@ -152,7 +154,7 @@ and MacOS permits running of unsigned binaries, however, to progress past this,
152154
<TabItem value="method1" label="Method #1 - Admin CLI ">
153155

154156
#### Method #1 - quickest method
155-
The xattr command will remove the quarantine attribute from the polykey executable, allowing you to run it without triggering macOS security warnings. Remember to ensure that the file path matches the location of your polykey file.
157+
The `xattr` command will remove the quarantine attribute from the Polykey executable, allowing you to run it without triggering macOS security warnings. Remember to ensure that the file path matches the location of your polykey file.
156158

157159
```sh
158160
sudo xattr -r -d com.apple.quarantine ~/Downloads/polykey
@@ -380,7 +382,7 @@ Install it with:
380382
npm install -g polykey-cli
381383
```
382384
383-
This will install the Polykey-CLI into `$(npm config get prefix)`.
385+
This will install the Polykey-CLI into the path pointed to by the command `$(npm config get prefix)`.
384386
385387
If the `npm` bin path is added to the `$PATH` environment variable, then you will be able to execute `pk` or `polykey`.
386388

0 commit comments

Comments
 (0)