diff --git a/README.md b/README.md index 2fba482..bc4915e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,20 @@ -#EasyCTF 2016 -The EasyCTF website for the 2016 competition. +# EasyCTF 2016 + +Platform for the EasyCTF 2016 competition. + +## Installation + +If you have Vagrant installed, setting up the platform should be a piece of cake. + +1. Navigate to the root directory of this project. +2. Perform a `vagrant up` to create a virtual machine using the Vagrantfile. +3. Perform a `vagrant ssh` to SSH into the virtual machine. +4. Once you're inside the virtual machine, run `deploy` to start the server. +5. Open [localhost:8080](http://localhost:8080) on your local machine to see if it works. + +If you have any issues during installation, file an issue. + +## Notes **Resources** : Flask, MySQL