Skip to content

Commit

Permalink
small docs touch ups
Browse files Browse the repository at this point in the history
  • Loading branch information
christophevg committed Nov 14, 2023
1 parent 212c2a4 commit 2550abc
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 7 deletions.
5 changes: 1 addition & 4 deletions docs/building-your-first-baseweb-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,9 @@ This is optional, still very much advised: prepare a suitable execution environm
This is enough to install baseweb. Now to run your first baseweb app, you will need a webserver, like `gunicorn` with `eventlet` support:

```bash
% pip install https://github.com/benoitc/gunicorn/archive/ff58e0c6da83d5520916bc4cc109a529258d76e1.zip#egg=gunicorn==20.1.0
% pip install eventlet==0.33.2
% pip install gunicorn eventlet
```

(There's an issue requiring these specific versions: [https://stackoverflow.com/questions/67409452/gunicorn-importerror-cannot-import-name-already-handled-from-eventlet-wsgi](https://stackoverflow.com/questions/67409452/gunicorn-importerror-cannot-import-name-already-handled-from-eventlet-wsgi))

All set. Let's meet baseweb...

## Hello baseweb
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ $ pip install baseweb
To actually run baseweb you need additionally a web server, like gunicorn, optionally with async support, e.g. using eventlet.

```bash
$ pip install https://github.com/benoitc/gunicorn/archive/ff58e0c6da83d5520916bc4cc109a529258d76e1.zip
$ pip install eventlet
$ pip install gunicorn eventlet
```

Now you can start a stock baseweb using:
Expand All @@ -33,6 +32,7 @@ To quickly add a little more, clone the baseweb-demo repository and give that a

```bash
% git clone https://github.com/christophevg/baseweb-demo
% pip install oatk
% gunicorn -k eventlet -w 1 baseweb-demo:server
```

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
![Build Status](https://github.com/christophevg/baseweb/actions/workflows/test.yaml/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/baseweb/badge/?version=latest)](https://baseweb.readthedocs.io/en/latest/?badge=latest)
[![Coverage Status](https://coveralls.io/repos/github/christophevg/baseweb/badge.svg?branch=master)](https://coveralls.io/github/christophevg/baseweb?branch=master)
[![Built with PyPi Template](https://img.shields.io/badge/PyPi_Template-v0.4.5-blue.svg)](https://github.com/christophevg/pypi-template)
[![Built with PyPi Template](https://img.shields.io/badge/PyPi_Template-v0.4.6-blue.svg)](https://github.com/christophevg/pypi-template)


## Contents
Expand Down

0 comments on commit 2550abc

Please sign in to comment.