Skip to content

Commit a1c666a

Browse files
authored
update README.md
1 parent 7eee6b2 commit a1c666a

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
# docs.openssl.org
44

5-
OpenSSL Documentation website is based on
5+
The OpenSSL Documentation website is based on
66
[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and
7-
this repository contains required configuration and build scripts.
7+
this repository contains the required configuration files and build scripts.
8+
`docs.openssl.org` is hosted on GitHub Pages.
89

910
## Deployment
1011

@@ -37,7 +38,7 @@ To start playing around you can spin up a container and run commands:
3738
3. Build the docs:
3839

3940
```sh
40-
python build.py <OPENSSL VERSION>
41+
python build.py <OPENSSL BRANCH>
4142
```
4243

4344
4. Run the development web server:
@@ -48,7 +49,7 @@ To start playing around you can spin up a container and run commands:
4849

4950
## build.py
5051

51-
A small wrapper script to clone a specific OpenSSL branch and build documentaton website with
52+
A small wrapper script to clone a specific OpenSSL branch and build a documentation website with
5253
`mike`. Run it to build the website:
5354

5455
```sh

0 commit comments

Comments
 (0)