Skip to content
This repository was archived by the owner on Mar 31, 2020. It is now read-only.

Commit f47a21b

Browse files
authored
first draft of task.
1 parent c3c15f5 commit f47a21b

File tree

1 file changed

+45
-2
lines changed

1 file changed

+45
-2
lines changed

README.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,45 @@
1-
# code-jam-4
2-
Task for our fourth code jam!
1+
# Code Jam IV: This app hates you!
2+
3+
The theme for this code jam will be **This app hates you!**. You will be creating an application using a GUI library of your choice in Python. The application must serve a real purpose, but must also fit the theme.
4+
5+
You can use any GUI library that you wish to use, but you have to make _a desktop app_. For example, you may use frameworks like PySide, PyQt, tkinter, wxPython or PySimpleGUI. You can even use stuff like Kivy or PyGame, although we do not recommend that you do. You may not, however, use webframeworks like Django or Flask, and you may not use anything that turns HTML and CSS into a desktop app that runs as a browser.
6+
7+
Here are a couple of examples of what we mean by an application that "serves a real purpose but also fits the theme":
8+
* A calculator app that calculates the right answers, but represents the answer in a way that's completely impractical.
9+
* An image resizer where you have to specify which part of the image to resize, specify how much force to apply to the resize operation in newtons, and then manually resize the image by turning a crank.
10+
* An alarm clock app that plays a very loud reminder sound effect every 5 minutes letting you know that your alarm will ring in 6 hours, but then fails to actually ring when the 6 hours are up.
11+
12+
Remember that teamwork is not optional for our code jams - You must find a way to work together. For this jam, we've assigned a leader for each team based on their responses to the application form. Remember to listen to your leader, and communicate with the rest of your team!
13+
14+
**Remember to provide instructions on how to set up and run your app at the bottom of this README**.
15+
16+
# Tips
17+
18+
* Please lint your code, and listen to the linter. We recommend **flake8**, and you can use `pipenv run lint` to run it. We will be evaluating your style, and unlinted code will lead to point deductions.
19+
* Remember to work closely with the rest of your team. We will deduct points for poor teamwork.
20+
* Don't overcomplicate this. It's better to write a relatively simple app that is 100% feature complete than failing to finish some ambitious project.
21+
* For information on how the Code Jam will be judged, please see [this document](https://wiki.pythondiscord.com/wiki/jams/judging).
22+
23+
# Setting Up
24+
25+
You should be using [Pipenv](https://pipenv.readthedocs.io/en/latest/). Take a look
26+
[at the documentation](https://pipenv.readthedocs.io/en/latest/) if you've never used it before. In short:
27+
28+
* Setting up for development: `pipenv install --dev`
29+
* Running the application (assuming you use our project layout): `pipenv run start`
30+
31+
# Project Information
32+
33+
`# TODO`
34+
35+
## Description
36+
37+
`# TODO`
38+
39+
## Setup & Installation
40+
41+
`# TODO`
42+
43+
## How do I use this thing?
44+
45+
`# TODO`

0 commit comments

Comments
 (0)