Skip to content

Commit 1713e2b

Browse files
committed
added pipenv Troubleshooting and other minor updates
1 parent d10e4b1 commit 1713e2b

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

+21-7
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22

33
Source for `creativecommons.github.io`
44

5+
**:warning: DO *NOT* MAKE CHANGES TO THE [creativecommons.github.io][ccghiorepo]
6+
REPO DIRECTLY**.
7+
8+
[ccghiorepo]:https://github.com/creativecommons/creativecommons.github.io
9+
510

611
## Overview
712

813
This site is built using [Lektor][lektor]. All changes to
914
[https://creativecommons.github.io][ccgithubio] must be made **here** and
10-
deployed via lektor (see [Deploying](#deploying), below).
11-
12-
**:warning:DO *NOT* MAKE CHANGES TO THE [creativecommons.github.io][ccghiorepo]
13-
REPO DIRECTLY**.
15+
deployed via lektor (see [Deployment](#deployment), below).
1416

1517
[lektor]:https://www.getlektor.com/
1618
[ccgithubio]:https://creativecommons.github.io
17-
[ccghiorepo]:https://github.com/creativecommons/creativecommons.github.io
1819

1920

2021
## Installation
@@ -28,6 +29,17 @@ REPO DIRECTLY**.
2829
[pipenvdocs]:https://pipenv.readthedocs.io/en/latest/
2930

3031

32+
### pipenv Troubleshooting
33+
34+
`pipenv` doesn't always provide the best error messages ([Provide better error
35+
message if the project’s virtual environment is broken][pipenverror]). If all
36+
else fails, try removing the virtual environment and reinstalling:
37+
1. `pipenv --rm`
38+
2. `pipenv install`
39+
40+
[pipenverror]:https://github.com/pypa/pipenv/issues/1918
41+
42+
3143
## Development
3244

3345
1. Run `pipenv shell` to spawn a shell with the virtualenv activated
@@ -38,9 +50,11 @@ REPO DIRECTLY**.
3850
[lektorlocal]:http://localhost:5000/
3951

4052

41-
## Deploying
53+
## Deployment
54+
55+
We have continuous deployment set up. Travis CI builds and deploys the site
56+
whenever it detects new commits on the `master` branch.
4257

43-
We have continuous deployment set up. Travis CI builds and deploys the site whenever it detects new commits on the `master` branch.
4458

4559
### Manual Deployment
4660

0 commit comments

Comments
 (0)