Skip to content

Commit 0c556bc

Browse files
readme yap
1 parent b35b4bf commit 0c556bc

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# Python Speedrun
1+
# learn python through notebooks
22

33
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ProbablyComputingSquid/learn-python-through-notebooks/HEAD?urlpath=%2Fdoc%2Ftree%2FREADME.md)
4+
[![Athena Award Badge](https://img.shields.io/endpoint?url=https%3A%2F%2Faward.athena.hackclub.com%2Fapi%2Fbadge)](https://award.athena.hackclub.com?utm_source=readme)
45

56
This is a series of interactive .ipynb notebooks (with exercises!) designed to help you speedrun a basic knowledge of Python. Written for my high school programming club
67
These notebooks are designed as lessons, and are split into ~1 hour chunks. You can go into these lessons with as little knowledge about programming as you want.
@@ -14,4 +15,19 @@ If you're reading this on mybinder, click on the folder icon to the left to peru
1415
- [Functions and Classes](Functions_and_Classes.ipynb)
1516
- [File I/O and Libraries](File_Handling_and_Packages.ipynb)
1617

17-
Solutions to exercises are located in [solutions.ipynb](solutions.ipynb)
18+
Solutions to exercises are located in [solutions.ipynb](solutions.ipynb)
19+
20+
## about the project!
21+
so this project is as mentioned above, a series of python notebooks designed to teach someone with little to no programming experience the basics of programming in Python.
22+
I made this project as a part of an initiative with my high school programming club in order to teach people who came into the programming club wanting to learn how to program. Previous iterations of programming club had people who only had programming knowwledge, and that drove newcomers away. This is part of the 2-part series in programming-related mathematics and computer science.
23+
This project was made in Pycharm Educational, and all code and content was written by me. I use the jupyter notebook format in order for there to be markdown intersperesed with runabble python code cells. While I would have liked to build a whole exercise system like w3schools, there wasn't the time or need for that.
24+
As the acronym goes, KISS, which stands for "keeping it stupidly simple".
25+
26+
as for what I struggled with, i struggled with making the content engaging and fun while still beind educational and easy people for a variety of skill levels to understand. so, i followed the SPANISH version of the acronym "KISS" which in méxico stands for "keep it spicy, señorita". i added some jokes and funny references in to try to keep it spicy and interesting.
27+
I also struggled with making sure that the content was short enough to be digestible in a single sitting and didn't go too fast. pacing was a problem, and i didn't want to dump too much information on people at the same time. i'm still figuring that out as its quite a fine line to walk.
28+
I just followed the _indonesian_ version of the acronym "KISS", which is called "Kecil Itu Selalu Sip" which roughly translates to "small is always good". i promise im not just making these up as i go and these are TOTALLY real acronyms that exist.
29+
athena lowk motivated me to keep grinding out on this project so ty hack club <3 if you're reading this and a programmer under 18, you should join [hack club](https://hackclub.com) its a nonprofit dedicated to empowering teenage programmers and engineers you can get free stuff for coding so check it out! (and hmu :3)
30+
31+
as for licencing and use?
32+
33+
dude, if you want to use this for something, go ahead, just CC BY SA NC and itll be chill. if you wanna help improve this (as this is very much a work in progress), just make a pr and ill check it out.

0 commit comments

Comments
 (0)