README rework (#30)

Also adds information about setting up a dev
environment

Author: JasonGrace2282

README.md

@@ -1,9 +1,22 @@
-# Tin: Turn-In
-
-The ultimate grader solution for TJHSST Aritifical Intelligence classes.
+<p align="center">
+  <img src="./assets/tin-logo.gif" width="500">
+</p>
+<br>
+<br>
+<p align="center">
+  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a>
+  <img src="https://github.com/tjcsl/tin/actions/workflows/ci.yml/badge.svg">
+  <a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit"></a>
+  <br>
+  <br>
+  <i>An autograder for Computer Science Classes</i>
+</p>
+<hr>
 
 ## History
-Previously, teachers in TJHSST AI classes had to manually run student code.
+Previously, teachers in TJHSST CS classes had to manually run student code. As you can imagine,
+this was both time consuming, and dangerous. In order to solve this problem, Tin was invented
+to safely run student code submissions.
 
 ## Architecture
 Tin is a Django application backed by PostgreSQL and SQLite. We use Celery (with a RabbitMQ broker) to process tasks.
@@ -13,8 +26,37 @@ Tin is a Django application backed by PostgreSQL and SQLite. We use Celery (with
 * Uploads for teacher's grader scripts
 * Customized containers for grader scripts
 
-## Data Backup
+## Developing
+To work on Tin, you'll need the following:
+* `pipenv`
+* `git`
+* A Github account
+
+First, [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#forking-a-repository) Tin.
+Then you can clone Tin onto your local computer with
+```bash
+git clone https://github.com/your_github_username/tin
+```
+After that, install dependencies:
+```bash
+pipenv install --dev
+```
 
+And finally, apply the database migrations and create some users.
+
+Note: if you're on Windows, replace `python3` with `python` in the commands below
+```bash
+python3 manage.py migrate
+python3 create_debug_users.py
+```
+Now you can run the Tin development server!
+```bash
+python3 manage.py runserver
+```
+Head over to [http://127.0.0.1:8000](http://127.0.0.1:8000), and
+login with the username `admin` and the password you just entered.
+
+## Data Backup
 ```bash
 python manage.py dumpdata --natural-foreign --natural-primary -e contenttypes -e admin -e auth.Permission > export_YYYY_MM_DD.json
 # copy to local machine

assets/logo.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+import sys
+
+try:
+    from manim import *
+    from manim.utils.color.BS381 import BEIGE
+except ImportError:
+    print("Seems you don't have Manim installed...")
+    print("You can install it by following the instructions at")
+    print("https://docs.manim.community/en/stable/installation.html")
+    exit(1)
+
+
+class Logo(Scene):
+    def construct(self):
+        name = Tex("TJ CSL").scale(1.5)
+        full = Tex("Turn-In").scale(3)
+        VGroup(name, full).arrange(DOWN)
+
+        subtext = Text("TJHSST's Code Autograder", color=BEIGE).next_to(full, DOWN, buff=2)
+
+        name.to_edge(RIGHT).shift(RIGHT*name.width)
+        full.to_edge(LEFT).shift(LEFT*full.width)
+        self.play(
+            name.animate(rate_func=rate_functions.ease_out_bounce).set_x(0).set_color(GREEN),
+            full.animate(rate_func=rate_functions.ease_out_bounce).set_x(0).set_color(BEIGE),
+        )
+        self.play(Create(subtext))
+        self.wait(4)
+        self.play(Uncreate(VGroup(name, full, subtext)), run_time=1)
+        self.wait(.1)
+
+
+def main():
+    args: dict[str, bool | str] = {"preview": True}
+    DEBUG = "--final" in sys.argv
+    if not DEBUG:
+        args["format"] = "gif"
+        args["transparent"] = True
+    with tempconfig(args):
+        Logo().render()
+
+if __name__ == "__main__":
+    main()