aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPridon Tetradze <[email protected]>2022-06-26 20:36:35 +0400
committerGitHub <[email protected]>2022-06-26 20:36:35 +0400
commitc7e06f35d9f4b6ac685d59de0ea7d062f520d0e0 (patch)
tree2960005f10b017eadd0caebbc3dd17ab957015b6
parent84a7812a082d65d41da8be8b63759c7cbe0cdad5 (diff)
downloadcountryfetch-c7e06f35d9f4b6ac685d59de0ea7d062f520d0e0.tar.xz
countryfetch-c7e06f35d9f4b6ac685d59de0ea7d062f520d0e0.zip
Update README.md
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4461483..8a81025 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,8 @@
## Installation
+### Default Way
+
clone this repository:
```bash
@@ -23,9 +25,11 @@ cd ./countryfetch
./install.sh
```
-The app should now be installed.
+The app should now be installed. This method should work for most users.
+
+### Another Way
-alternatively, you can compile it yourself and store it in your local bin directory (might be safer):
+alternatively, you can compile it yourself and store it in your local bin directory:
```bash
deno compile --allow-all index.ts
@@ -37,6 +41,7 @@ If after this your shell cannot find countryfetch, this means you haven't added
```bash
alias countryfetch="~/.local/bin/countryfetch"
```
+> **Note:** The executable you get from compilation can be stored and accessed from anywhere. Using the default way (install.sh), the installer simply runs `deno install --allow-all` and stores the executable in ~/.deno/bin/, which (if you have installed deno) should already be added to PATH, therefore you don't need any aliases. Your shell should be able to detect the command `countryfetch`.
## Usage