Skip to content

Commit 3059ead

Browse files
author
Chase Allbee
committed
Update README to outline prerequisites
1 parent 5b293ac commit 3059ead

File tree

2 files changed

+39
-11
lines changed

2 files changed

+39
-11
lines changed

README.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,34 @@ This repository hosts scripts to generate self-contained installations of the [E
1010

1111
------
1212

13+
14+
### 1.1. Prerequisites
15+
16+
If you don't have Git, install it from [Git Downloads](https://git-scm.com/downloads).
17+
18+
Python, which the EBCLI Installer depends on, requires the following prerequisites for each operating system.
19+
20+
- **Linux**
21+
- **Ubuntu and Debian**
22+
23+
```shell
24+
build-essential zlib1g-dev libssl-dev libncurses-dev libffi-dev libsqlite3-dev libreadline-dev libbz2-dev
25+
```
26+
27+
- **Amazon Linux and Fedora**
28+
29+
```shell
30+
"Development Tools" zlib-devel openssl-devel ncurses-devel libffi-devel sqlite-devel.x86_64 readline-devel.x86_64 bzip2-devel.x86_64
31+
```
32+
33+
- **macOS**
34+
35+
```shell
36+
openssl zlib readline
37+
```
38+
39+
------
40+
1341
### 2. Use
1442

1543
------
@@ -24,7 +52,7 @@ git clone https://github.com/aws/aws-elastic-beanstalk-cli-setup.git
2452

2553
#### 2.2. Install/Upgrade the EB CLI
2654

27-
On **Bash** and **Zsh** on OS X/Linux:
55+
On **Bash** and **Zsh** on macOS and Linux:
2856

2957
```shell
3058
./aws-elastic-beanstalk-cli-setup/scripts/bundled_installer
@@ -40,17 +68,17 @@ In **PowerShell** or in a **Command Prompt** window:
4068

4169
- **Linux**
4270

43-
Almost all installation problems experienced by customers on Linux/OS X have been due to missing libraries such as OpenSSL, bzip2, etc.
71+
Most installation problems have been due to missing libraries such as `OpenSSL`.
4472

45-
- On **Ubuntu/Debian**, run:
73+
- On **Ubuntu and Debian**, run the following command to install dependencies.
4674

4775
```shell
4876
apt-get install \
4977
build-essential zlib1g-dev libssl-dev libncurses-dev \
5078
libffi-dev libsqlite3-dev libreadline-dev libbz2-dev
5179
```
5280

53-
- On **Amazon Linux/Fedora**, run:
81+
- On **Amazon Linux and Fedora**, run the following command to install dependencies.
5482

5583
```shell
5684
yum group install "Development Tools"
@@ -59,9 +87,9 @@ In **PowerShell** or in a **Command Prompt** window:
5987
sqlite-devel.x86_64 readline-devel.x86_64 bzip2-devel.x86_64
6088
```
6189

62-
- **OS X**
90+
- **macOS**
6391

64-
Most problems on OS X have been with loading and linking OpenSSL and zlib. The following commands install necessary packages and tell the Python installer where to find them.
92+
Most installation problems on macOS are related to loading and linking OpenSSL and zlib. The following command installs the necessary packages and tells the Python installer where to find them:
6593

6694
```
6795
brew install zlib openssl readline
@@ -70,12 +98,12 @@ In **PowerShell** or in a **Command Prompt** window:
7098

7199
- **Windows**
72100

73-
- In PowerShell, upon executing `bundled_installer`, if you see an error with the message "execution of scripts is disabled on this system", set the [execution policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-6) to "RemoteSigned" and then rerun `bundled_installer`.
101+
- In PowerShell, if you encounter an error with the message "execution of scripts is disabled on this system", set the [execution policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-6) to `"RemoteSigned"` and then rerun `bundled_installer`.
74102

75103
```ps1
76104
Set-ExecutionPolicy RemoteSigned
77105
```
78-
- If you encounter an error that states "No module named 'virtualenv'", then you can perform the following commands to remedy this issue:
106+
- If you encounter an error with the message "No module named 'virtualenv'", use the following commands to install `virtualenv` and the EB CLI:
79107
```ps1
80108
pip uninstall -y virtualenv
81109
pip install virtualenv
@@ -84,7 +112,7 @@ In **PowerShell** or in a **Command Prompt** window:
84112

85113
#### 2.4. After installation
86114

87-
On Linux and OS X, the output will contain instructions to add the EB CLI (and Python) executable file to the shell's `$PATH` variable, if it isn't already in it.
115+
On Linux and macOS, the output contains instructions to add the EB CLI (and Python) executable file to the shell's `$PATH` variable, if it isn't already in it.
88116

89117
#### 2.5. Demo execution of `bundled_installer`
90118

@@ -228,4 +256,4 @@ for testing purposes, even though the Elastic Beanstalk team tests the EB CLI ag
228256
229257
### 5. License
230258
231-
This library is licensed under the Mozilla Public License Version 2.0.
259+
This library is licensed under the Mozilla Public License Version 2.0.

scripts/ebcli_installer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -875,4 +875,4 @@ def _python_script_body(virtualenv_location):
875875
_announce_success(
876876
virtualenv_location,
877877
arguments_context.hide_export_recommendation
878-
)
878+
)

0 commit comments

Comments
 (0)