Skip to content

Commit

Permalink
Fill out the README
Browse files Browse the repository at this point in the history
  • Loading branch information
jackrosenthal committed Feb 13, 2024
1 parent 941377e commit 1ecaafd
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 5 deletions.
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
include README.md
include VERSION
recursive-include algobowl/public *
include algobowl/public/favicon.ico
Expand Down
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# AlgoBOWL

AlgoBOWL is a group project for algorithms courses. Students compete to create
heuristics to an NP-hard problem. For more information, see the paper in
[ITiCSE 2019](https://doi.org/10.1145/3304221.3319761).

This is the AlgoBOWL web application, as well as associated tools (e.g., command
line interface).

## Getting Started

The rest of this `README` assumes you're interested in hacking on the AlgoBOWL
code, and want to install the web app locally. For other topics of interest,
check out the `docs/` directory.

You'll need a system running Linux and Python 3.8+.

Create and activate a virtual environment to install in:

```shellsession
$ python3 -m venv venv
$ . venv/bin/activate
```

Next, install the app in editable mode::

```shellsession
$ pip install -e ".[dev]"
```

Next, copy the sample development config and setup the application::

```shellsession
$ cp development.ini.sample development.ini
$ gearbox setup-app
```

Finally, you can serve the app::

```shellsession
$ gearbox serve --reload --debug
```

Have fun!
4 changes: 0 additions & 4 deletions README.rst

This file was deleted.

4 changes: 3 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@
setuptools.setup(
name="algobowl",
version=(HERE / "VERSION").read_text(encoding="ascii").strip(),
description="",
description="Competition-based group project for Algorithms courses",
long_description=(HERE / "README.md").read_text(encoding="utf-8"),
long_description_content_type="text/markdown",
author="",
author_email="",
url="",
Expand Down

0 comments on commit 1ecaafd

Please sign in to comment.