Skip to content

Commit 3c0e422

Browse files
authored
Update README.md
1 parent a2691e6 commit 3c0e422

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,20 @@ adl helps generate markdown files for capturing information in an ADR and genera
66

77
## How to use
88

9-
Install adl and add it to your path.
9+
Install adl and add it to your path. **Do not run copy/paste this script. Read it, and run only the parts that you need.**
1010

1111
```bash
12+
# Use the appropriate binary for your OS and Arch
13+
binary="adl_linux_arm" # linux arm
14+
binary="adl_linux_x86" # linux x86
15+
binary="adl_mac_arm" # mac arm
16+
binary="adl_mac_x86" # mac x86
17+
binary="adl_windows_x86" # windows
18+
1219
# curl, follow redirects, output to "adl", download target latest release
13-
curl -L -o adl https://github.com/bradcypert/adl/releases/latest/download/adl
20+
curl -L -o adl https://github.com/bradcypert/adl/releases/latest/download/$binary
1421

15-
# Update permissions for adl
22+
# You _may_ need to update permissions for adl
1623
chmod 744 adl
1724

1825
# You probably also want to move this to a place that exists in your path

0 commit comments

Comments
 (0)