Skip to content

Commit 1b45e49

Browse files
authored
Merge pull request #130 from creativecommons/found-tech-readme
Reference Foundational Technologies page instead of having duplicated project documentation
2 parents 9e2aca0 + 88928ee commit 1b45e49

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

+7-11
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,6 @@ This project seeks to quantify the size and diversity of the commons--the
99
collection of works that are openly licensed or in the public domain.
1010

1111

12-
### 2024 Status
13-
14-
This project is currently being worked on as a Google Summer of Code (GSoC)
15-
project. The goal is to add automation of data gathering and report generation
16-
so that our reports quantifying the commons are never more than 3 months out of
17-
date. To prepare for this refactor, previous work was moved to
18-
[`pre-automation/`](pre-automation/).
19-
20-
2112
## Code of conduct
2213

2314
[`CODE_OF_CONDUCT.md`][org-coc]:
@@ -87,6 +78,10 @@ Quantifying/
8778

8879
### Prerequisites
8980

81+
For information on learning and installing the prerequisite technologies for
82+
this project, please see [Foundational technologies — Creative Commons Open
83+
Source][found-tech].
84+
9085
This repository uses [pipenv][pipenvdocs] to manage the required Python
9186
modules:
9287
1. Install `pipenv`:
@@ -104,6 +99,7 @@ modules:
10499
pipenv sync --dev
105100
```
106101

102+
[found-tech]: https://opensource.creativecommons.org/contributing-code/foundational-tech/
107103
[pipenvdocs]: https://pipenv.pypa.io/en/latest/
108104
[pipenvinstall]: https://pipenv.pypa.io/en/latest/installation/
109105
[homebrew]: https://brew.sh/
@@ -121,8 +117,8 @@ follow these steps:
121117
2. Uncomment the variables in the `.env` file and assign values as needed. See
122118
[`sources.md`](sources.md) on how to get credentials:
123119
```
124-
GOOGLE_API_KEYS=your_api_key
125-
PSE_KEY=your_pse_key
120+
GCS_DEVELOPER_KEY = your_api_key
121+
GCS_CX = your_pse_id
126122
```
127123
3. Save the changes to the `.env` file.
128124
4. You should now be able to run scripts that require client credentials

0 commit comments

Comments
 (0)