Skip to content

Commit ffc96f4

Browse files
Update README.md
1 parent 92eacfc commit ffc96f4

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22

33
The Programming Contest Suite is a set of tools for running [ICPC](https://icpc.global) style programming competitions hosted by the [Association for Computing Machinery Florida State University Student Chapter](https://fsu.acm.org). The PCS is a [Django](https://www.djangoproject.com/) powered contest account registration & management application working alongside the [DOMJudge](https://www.domjudge.org/) jury system.
44

5-
## Getting Started
6-
Ensure the target development or production machine has a functioning installiation of [Docker](https://www.docker.com) with `docker-compose` and `docker-swarm`.
7-
### Development Deployment
5+
## Installation
6+
Ensure the target machine has a functioning installation of [Docker](https://www.docker.com) with `docker-compose` and `docker-swarm`. Obtain a copy of the project by cloning the reposity, or downloading one of our [official releases](https://github.com/FSU-ACM/Programming-Contest-Suite/releases).
7+
8+
#### Clone
9+
git clone https://github.com/FSU-ACM/Programming-Contest-Suite.git
10+
11+
## Deployment
12+
### Development
813
From the project root, navigate to the development folder:
914

1015
cd deploy/dev
@@ -18,7 +23,7 @@ Launch the project in dev mode:
1823
docker-compose up
1924

2025
NOTE: In order to monitor the debug logs, as well as view any emails the suite sends while in debug, it is suggested to NOT use the `-d` flag with the `docker-compose up` command.
21-
### Production Deployment
26+
### Production
2227
The following steps are intended for deploying the suite on the Chapter's server, Agon.
2328

2429
Initialize the swarm:

0 commit comments

Comments
 (0)