Skip to content

Commit 92dd7c7

Browse files
authored
Fix README typos (#9920)
1 parent c7d2106 commit 92dd7c7

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ tarball or a git checkout.
99

1010
## Architecture
1111

12-
pgAdmin 4 is written as a web application with Python(Flask) on the server side
12+
pgAdmin 4 is written as a web application with Python (Flask) on the server side
1313
and ReactJS, HTML5 with CSS for the client side processing and UI.
1414

1515
Although developed using web technologies, pgAdmin 4 can be deployed either on
1616
a web server using a browser, or standalone on a workstation. The runtime/
17-
subdirectory contains an Electron based runtime application intended to allow this,
17+
subdirectory contains an Electron-based runtime application intended to allow this,
1818
which will fork a Python server process and display the UI.
1919

2020
## Prerequisites
@@ -31,11 +31,11 @@ corepack enable
3131

3232
# Building the Web Assets
3333

34-
pgAdmin is dependent on a number of third party Javascript libraries. These,
35-
along with it's own Javascript code, CSS code and images must be
34+
pgAdmin is dependent on a number of third-party JavaScript libraries. These,
35+
along with its own JavaScript code, CSS code and images must be
3636
compiled into a "bundle" which is transferred to the browser for execution
3737
and rendering. This is far more efficient than simply requesting each
38-
asset as it's needed by the client.
38+
asset as it is needed by the client.
3939

4040
To create the bundle, you will need the 'yarn' package management tool to be
4141
installed. Then, you can run the following commands on a *nix system to
@@ -60,7 +60,7 @@ C:\$PGADMIN4_SRC\web> yarn run bundle
6060

6161
In order to run the Python code, a suitable runtime environment is required.
6262
Python version 3.9 and later are currently supported. It is recommended that a
63-
Python Virtual Environment is setup for this purpose, rather than using the
63+
Python virtual environment is set up for this purpose, rather than using the
6464
system Python environment. On Linux and Mac systems, the process is fairly
6565
simple - adapt as required for your distribution:
6666

@@ -112,17 +112,17 @@ simple - adapt as required for your distribution:
112112
# Change pgAdmin data directory
113113
DATA_DIR = '/Users/myuser/.pgadmin_dev'
114114

115-
#Change pgAdmin server and port
115+
# Change pgAdmin server and port
116116
DEFAULT_SERVER = '127.0.0.1'
117117
DEFAULT_SERVER_PORT = 5051
118118

119119
# Switch between server and desktop mode
120120
SERVER_MODE = True
121121

122-
#Change pgAdmin config DB path in case external DB is used.
122+
# Change pgAdmin config DB path in case an external DB is used.
123123
CONFIG_DATABASE_URI="postgresql://postgres:postgres@localhost:5436/pgadmin"
124124

125-
#Setup SMTP
125+
# Set up SMTP
126126
MAIL_SERVER = 'smtp.gmail.com'
127127
MAIL_PORT = 465
128128
MAIL_USE_SSL = True
@@ -172,7 +172,7 @@ server or desktop mode, and access it from a web browser using the URL shown in
172172
the terminal once pgAdmin has started up.
173173

174174
Setup of an environment on Windows is somewhat more complicated unfortunately,
175-
please see *pkg/win32/README.txt* for complete details.
175+
please see *pkg/win32/README.md* for complete details.
176176

177177
# Building the documentation
178178

@@ -226,9 +226,9 @@ with all the required packages, and then run:
226226
(venv) $ make pip
227227
```
228228

229-
To build the macOS AppBundle, please see *pkg/mac/README*.
229+
To build the macOS AppBundle, please see *pkg/mac/README.md*.
230230

231-
To build the Windows installer, please see *pkg/win32/README.txt*.
231+
To build the Windows installer, please see *pkg/win32/README.md*.
232232
# Create Database Migrations
233233

234234
In order to make changes to the SQLite DB, navigate to the 'web' directory:

0 commit comments

Comments
 (0)