Skip to content

Commit be82ff5

Browse files
committed
Update README with information on usage, add starting directories
1 parent e5fe055 commit be82ff5

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
11
# pyladies-chapter-resources
22
A repository for PyLadies chapter resources including presentation materials and education plans for talks, tutorials, and other resources used for running meetups.
3+
4+
### How to use
5+
6+
PyLadies members are free to use resources from this repository as they see fit, provided they follow the usage terms outlined in the [Creative Commons License 4.0](https://creativecommons.org/licenses/by-sa/4.0/) included in this repository.
7+
8+
TL;DR you are free to:
9+
10+
* Share — copy and redistribute the material in any medium or format
11+
* Adapt — remix, transform, and build upon the material for any purpose, even commercially.
12+
13+
Under the following terms:
14+
15+
* Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
16+
* ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
17+
18+
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
19+
20+
Therefore, if you were using a resource from this repository for a PyLadies event, such as a workshop, you need to include in the slide stack a link back to this repository including any author information uploaded with the resource.
21+
22+
### Adding resources
23+
24+
To add a resource to the repository:
25+
26+
1. Locate the matching topic directory (e.g. machine learning). Is there one? Great! If there isn't a topic directory, make one!
27+
2. Create a directory that will house your resources in the topic directory. Your resource directory should include:
28+
- Slides
29+
- Any articulating resources (e.g. white papers if needed)
30+
- If your resource is a clas or workshop, include the classroom plan.
31+
- Create a README that includes the date you uploaded the resources, your PyLadies chapter information, and author information. Author information should be used by all PyLadies who go on to use this resource in their programming, as outlined in the Creative Commons License usage (see above on "How to use"). If you are open to people contacting you with questions, please specify in the author information.
32+
3. Make a PR with all the information above titling the PR "Adding <Resource Name> to <Topic Directory>"
33+
4. The PyLadies global team will review and merge in!
34+
35+
### Questions?
36+
37+
If you have any questions, reach out to PyLadies on the [PyLadies Slack](https://slackin.pyladies.com/)! Alternatively, you can email info@pyladies.com or open an issue with 'HELP' in the title.

0 commit comments

Comments
 (0)