Skip to content

Commit 4898369

Browse files
committed
dev2019 updates
1 parent b8d535d commit 4898369

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

README.md

+28-6
Original file line numberDiff line numberDiff line change
@@ -119,12 +119,6 @@ CC0 1.0 | [Source File][cc-zero-source] | [Legal Code][cc-zero-legalcode] | [Dee
119119

120120
## Installation
121121

122-
:warning: **WARNING:** Use of the bootstrap scripts in the master branch is NOT
123-
recommended. Instead, see the [dev2019][dev2019] branch for current/ongoing
124-
work.
125-
126-
[dev2019]: https://github.com/creativecommons/creativecommons.org/tree/dev2019
127-
128122

129123
### Child Repositories
130124

@@ -152,6 +146,34 @@ As of 2019 December, there are around 9,700 lines of python code split between
152146
the repositories.
153147

154148

149+
### License Engine Setup
150+
151+
:warning: **NOTE:** The dev2019 branch for this and the child repositories are
152+
currently under active development.
153+
154+
1. **Install pipenv**: Make sure you have [pipenv][pipenvdocs] installed.
155+
2. **Execute Install Script**: `./sripts/setup_engine.sh`
156+
157+
1. Clones cc.engine and related respositories
158+
159+
- Checks out ARG1 branch (if specified)
160+
161+
2. Creates symlinks to support the semantic web
162+
3. Creates Python Environment via pipenv
163+
4. Generate ccengine.fcgi and copies config.ini into python_env
164+
5. Compiles mo files and transstats
165+
166+
- Creates transstats.csv convenience symlink
167+
168+
169+
### Not Included
170+
171+
This project does not currently include the [creativecommons/cc.api][ccapi]
172+
repository (which itself, depends on [creativecommons/cc.license][cclicense]).
173+
174+
[ccapi]: https://github.com/creativecommons/cc.api
175+
176+
155177
### Styles and other Includes
156178

157179
:warning: **WARNING:** Any change to style or other includes must be duplicated
File renamed without changes.

0 commit comments

Comments
 (0)