Skip to content

Commit

Permalink
docs: add instructions using a virtualenv (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
avivace committed Sep 19, 2023
1 parent 874acb5 commit 4bc40c0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ This is a community-maintained version of Tonc, the GBA programming tutorial ori

## Setup

You need Python 3. Dependencies can be installed via `pip` or your package manager.
You need Python 3. This example will set up a virtual environment and install dependencies inside it.

```sh
# clone the repo
git clone git@github.com:gbadev-org/tonc.git
cd tonc

# install dependencies
# (if your operating system distributor provides Python, follow the
# PEP 668 instructions to set up a venv first)
pip install pelican markdown
python -m venv env
source env/bin/activate

pip install -r requirements.txt

# run the development server
make devserver
Expand Down

0 comments on commit 4bc40c0

Please sign in to comment.