Skip to content

Commit 30c09a7

Browse files
TimidRobotTimidRobot
committed
update README
1 parent bd22d29 commit 30c09a7

File tree

1 file changed

+30
-159
lines changed

1 file changed

+30
-159
lines changed

‎README.md

+30-159
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,25 @@
11
# creativecommons.org
22

3-
Website parent project ([When we share, everyone wins - Creative
4-
Commons][ccorg]), legalcode and translations, and GitHub Issues for public
5-
help and support
63

7-
[ccorg]: https://creativecommons.org/
4+
## Help and support
85

6+
You can open an [issue][support] or see [Contact | Creative Commons][contact].
97

10-
## Overview
8+
[support]: https://github.com/creativecommons/creativecommons.org/issues
9+
[contact]: https://creativecommons.org/about/contact/
1110

12-
This repository is currently for:
13-
1. Public help and support [Issues][issues]
14-
2. Legalcode and translations
15-
3. Installation of the website (including Styles and other Includes)
16-
4. ~~License Engine (ccEngine) Setup~~
1711

18-
[issues]: https://github.com/creativecommons/creativecommons.org/issues
12+
## Legal code translations
1913

14+
This repository still contains some legal code translation efforts. We are in
15+
the process of moving all translations to the CC Legal Tools project and
16+
Transifex:
17+
- CC Legal Tools App: [creativecommons/cc-legal-tools-app][app]
18+
- CC Legal Tools Data: [creativecommons/cc-legal-tools-data][data]
2019

21-
## Code of Conduct
22-
23-
[`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md):
24-
> The Creative Commons team is committed to fostering a welcoming community.
25-
> This project and all other Creative Commons open source projects are governed
26-
> by our [Code of Conduct][code_of_conduct]. Please report unacceptable
27-
> behavior to [conduct@creativecommons.org](mailto:conduct@creativecommons.org)
28-
> per our [reporting guidelines][reporting_guide].
29-
30-
[code_of_conduct]:https://opensource.creativecommons.org/community/code-of-conduct/
31-
[reporting_guide]:https://opensource.creativecommons.org/community/code-of-conduct/enforcement/
32-
33-
34-
## Contributing
35-
36-
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
37-
38-
39-
## Issues
40-
41-
This repository's [Issues][issues] is also the primary location for public help
42-
and support.
43-
44-
45-
## Legalcode and Translations
46-
47-
Relevant directories:
48-
- [`docroot/legalcode`](docroot/legalcode/): legalcode and translations "source"
49-
files
20+
Relevant repository directories:
21+
- [`docroot/legalcode`](docroot/legalcode/): legalcode and translations
22+
"source" files
5023
- [`tools`](tools/): tools to assist with managing the translations
5124

5225
Also see:
@@ -55,138 +28,36 @@ Also see:
5528
- [Legal Tools Translation - CC Public Wiki][fourstatus]: Translation status
5629
for 4.0 and CC0 licenses
5730

31+
[app]: https://github.com/creativecommons/cc-legal-tools-app
32+
[data]: https://github.com/creativecommons/cc-legal-tools-data
5833
[translatepolicy]: https://wiki.creativecommons.org/wiki/Legal_Code_Translation_Policy
5934
[fourstatus]: https://wiki.creativecommons.org/wiki/Legal_Tools_Translation
6035

6136

62-
### English Licenses
63-
*Our public copyright licenses incorporate a unique and innovative
64-
"three-layer" design*:
65-
1. **Legal code**: the traditional legal tool *that most lawyers know and love*
66-
2. Human Readable **Deed**: *a format that normal people can read... a handy
67-
reference for licensors and licensees*
68-
3. Machine Readable **RDF**: *recognizes that software, from search engines to
69-
office productivity to music editing, plays an enormous role in the
70-
creation, copying, discovery, and distribution of works*
71-
([Three “Layers” Of Licenses - About The Licenses - Creative
72-
Commons][threelayer])
73-
74-
[threelayer]: https://creativecommons.org/licenses/#layers
75-
76-
License | Source File | Legal Code | Deed | RDF
77-
------- | ----------- | ---------- | ---- | ---
78-
CC BY-NC-ND 4.0 | [Source File][cc-by-nc-nd-source] | [Legal Code][cc-by-nc-nd-legalcode] | [Deed][cc-by-nc-nd-deed] | [RDF][cc-by-nc-nd-rdf]
79-
CC BY-NC-SA 4.0 | [Source File][cc-by-nc-sa-source] | [Legal Code][cc-by-nc-sa-legalcode] | [Deed][cc-by-nc-sa-deed] | [RDF][cc-by-nc-sa-rdf]
80-
CC BY-NC 4.0 | [Source File][cc-by-nc-source] | [Legal Code][cc-by-nc-legalcode] | [Deed][cc-by-nc-deed] | [RDF][cc-by-nc-rdf]
81-
CC BY-ND 4.0 | [Source File][cc-by-nd-source] | [Legal Code][cc-by-nd-legalcode] | [Deed][cc-by-nd-deed] | [RDF][cc-by-nd-rdf]
82-
CC BY-SA 4.0 | [Source File][cc-by-sa-source] | [Legal Code][cc-by-sa-legalcode] | [Deed][cc-by-sa-deed] | [RDF][cc-by-sa-rdf]
83-
CC BY 4.0 | [Source File][cc-by-source] | [Legal Code][cc-by-legalcode] | [Deed][cc-by-deed] | [RDF][cc-by-rdf]
84-
CC0 1.0 | [Source File][cc-zero-source] | [Legal Code][cc-zero-legalcode] | [Deed][cc-zero-deed] | [RDF][cc-zero-rdf]
85-
86-
[cc-by-nc-nd-source]: docroot/legalcode/by-nc-nd_4.0.html
87-
[cc-by-nc-nd-legalcode]: https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode.en
88-
[cc-by-nc-nd-deed]: https://creativecommons.org/licenses/by-nc-nd/4.0/deed.en
89-
[cc-by-nc-nd-rdf]: https://creativecommons.org/licenses/by-nc-nd/4.0/rdf
90-
91-
[cc-by-nc-sa-source]: docroot/legalcode/by-nc-sa_4.0.html
92-
[cc-by-nc-sa-legalcode]: https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.en
93-
[cc-by-nc-sa-deed]: https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en
94-
[cc-by-nc-sa-rdf]: https://creativecommons.org/licenses/by-nc-sa/4.0/rdf
95-
96-
[cc-by-nc-source]: docroot/legalcode/by-nc_4.0.html
97-
[cc-by-nc-legalcode]: https://creativecommons.org/licenses/by-nc/4.0/legalcode.en
98-
[cc-by-nc-deed]: https://creativecommons.org/licenses/by-nc/4.0/deed.en
99-
[cc-by-nc-rdf]: https://creativecommons.org/licenses/by-nc/4.0/rdf
100-
101-
[cc-by-nd-source]: docroot/legalcode/by-nd_4.0.html
102-
[cc-by-nd-legalcode]: https://creativecommons.org/licenses/by-nd/4.0/legalcode.en
103-
[cc-by-nd-deed]: https://creativecommons.org/licenses/by-nd/4.0/deed.en
104-
[cc-by-nd-rdf]: https://creativecommons.org/licenses/by-nd/4.0/rdf
105-
106-
[cc-by-sa-source]: docroot/legalcode/by-sa_4.0.html
107-
[cc-by-sa-legalcode]: https://creativecommons.org/licenses/by-sa/4.0/legalcode.en
108-
[cc-by-sa-deed]: https://creativecommons.org/licenses/by-sa/4.0/deed.en
109-
[cc-by-sa-rdf]: https://creativecommons.org/licenses/by-sa/4.0/rdf
110-
111-
[cc-by-source]: docroot/legalcode/by_4.0.html
112-
[cc-by-legalcode]: https://creativecommons.org/licenses/by/4.0/legalcode.en
113-
[cc-by-deed]: https://creativecommons.org/licenses/by/4.0/deed.en
114-
[cc-by-rdf]: https://creativecommons.org/licenses/by/4.0/rdf
115-
116-
[cc-zero-source]: docroot/legalcode/zero_1.0.html
117-
[cc-zero-legalcode]: https://creativecommons.org/publicdomain/zero/1.0/legalcode.en
118-
[cc-zero-deed]: https://creativecommons.org/publicdomain/zero/1.0/deed.en
119-
[cc-zero-rdf]: https://creativecommons.org/publicdomain/zero/1.0/rdf
120-
121-
122-
## Installation
123-
124-
125-
### Child Repositories
126-
127-
In addition to this one, the following child repositories are also used:
128-
129-
- License Engine (chooser, deeds, legalcode, RDFs):
130-
131-
- [creativecommons/cc.engine][ccengine]
132-
- [creativecommons/cc.i18n][cci18n]
133-
- [creativecommons/cc.license][cclicense]
134-
- [creativecommons/cc.licenserdf][cclicenserdf]
135-
- [creativecommons/rdfadict][rdfadict]
136-
137-
- WordPress and styles:
138-
139-
- [creativecommons/new-creativecommons.org][neworg]
140-
141-
[ccengine]: https://github.com/creativecommons/cc.engine
142-
[cci18n]: https://github.com/creativecommons/cc.i18n
143-
[cclicense]: https://github.com/creativecommons/cc.license
144-
[cclicenserdf]: https://github.com/creativecommons/cc.licenserdf
145-
[rdfadict]: https://github.com/creativecommons/rdfadict
146-
147-
As of 2019 December, there are around 9,700 lines of python code split between
148-
the repositories.
149-
150-
151-
### License Engine Setup
152-
153-
> :warning: **We do not support local development at this time. Creative
154-
> Commons maintains a staging server (configured per
155-
> [creativecommons/sre-salt-prime][sre-salt-prime]) for development.**
156-
157-
1. **Install prerequisites**:
158-
- [Redland RDF Libraries][redland] Python bindings (`python-librdf` package
159-
on Debian. Due to this prerequisite, setup on macOS is *not* recommended.)
160-
- [pipenv][pipenvdocs] (`pipenv` package on Debian)
161-
2. **Execute Install Script**: `./scripts/setup_engine.sh`
162-
([`scripts/setup_engine.sh`](scripts/setup_engine.sh))
163-
1. Clones cc.engine and related respositories
164-
- Checks out specified branch (`ARG1`, defaults to `master`)
165-
2. Creates symlinks to support the semantic web
166-
3. Creates Python Environment via pipenv
167-
4. Generate ccengine.fcgi and copies config.ini into python_env
168-
5. Compiles mo files and transstats
169-
- Creates `transstats.csv` convenience symlink
37+
## Code of Conduct
17038

171-
[sre-salt-prime]: https://github.com/creativecommons/sre-salt-prime
172-
[pipenvdocs]:https://pipenv.readthedocs.io/en/latest/
173-
[redland]: http://librdf.org/
39+
[`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md):
40+
> The Creative Commons team is committed to fostering a welcoming community.
41+
> This project and all other Creative Commons open source projects are governed
42+
> by our [Code of Conduct][code_of_conduct]. Please report unacceptable
43+
> behavior to [conduct@creativecommons.org](mailto:conduct@creativecommons.org)
44+
> per our [reporting guidelines][reporting_guide].
17445
46+
[code_of_conduct]:https://opensource.creativecommons.org/community/code-of-conduct/
47+
[reporting_guide]:https://opensource.creativecommons.org/community/code-of-conduct/enforcement/
17548

176-
### Not Included
17749

178-
This project does not currently include the [creativecommons/cc.api][ccapi]
179-
repository (which itself, depends on [creativecommons/cc.license][cclicense]).
50+
## Contributing
18051

181-
[ccapi]: https://github.com/creativecommons/cc.api
52+
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
18253

18354

184-
### Styles and other Includes
55+
## Legacy files
18556

186-
:warning: **WARNING:** Any change to style or other includes must be duplicated
187-
within the [creativecommons/new-creativecommons.org][neworg] repository.
57+
The previous contents of this repository are archived at
58+
[cc-archive/creativecommons.org-20230927][legacy].
18859

189-
[neworg]: https://github.com/creativecommons/new-creativecommons.org
60+
[legacy]: https://github.com/cc-archive/creativecommons.org-20230927
19061

19162

19263
## License

0 commit comments

Comments
 (0)