From cde1c742191a4cb2916465ae3d86d328dc105095 Mon Sep 17 00:00:00 2001 From: Vaibhav Sinha Date: Fri, 3 May 2019 07:17:08 +0530 Subject: [PATCH] Basic Readme (#59) * Basic Readme * Create LICENSE * Update README to include license --- LICENSE | 21 +++++++++++++++++++++ README.md | 31 ++++++++++++++++++++++++++++++- docs/source/index.rst | 3 +++ 3 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3013bed --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Vaibhav Sinha, Prateek Kumar, Vishwak Srinivasan + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 7b5373b..27e0eb7 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,33 @@ [![CircleCI](https://circleci.com/gh/vbsinha/pdp-judge.svg?style=svg&circle-token=779cf1772a65883845be7ded61285e17a63141de)](https://circleci.com/gh/vbsinha/pdp-judge) --- -More information coming soon! +This is an implementation of an online judge. +The portal can be used for conducting programming contests as well as managing assignments in a university. +Apart from the facilities of usual programming contest portals, this portal provides facilities which are well suited for assignment submission. +These additional features include: Instructor (Problem poster) grades above judge scores, soft and hard deadlines for assignments including penalties, customizable compilation and test script, linter scores etc. + +## Prerequisites + +The prerequisites are: +* Python 3.7 +* Django 2.2 +* social-auth-app-django (Install using ```pip install social-auth-app-django```) + +## Running the program + +* Clone this repo +* Go to the directory and run +``` +$ python manage.py makemigrations +$ python manage.py migrate +$ python manage.py runserver +``` +* Also run the `submission_watcher_saver` program. +To evaluate the submissions as and when they are submitted, it is preferred that the program be kept running in parallel with the judge server. +``` +$ python submission_watcher_saver.py +``` + +## License + +This code is licensed under [MIT](LICENSE). diff --git a/docs/source/index.rst b/docs/source/index.rst index cbe2f3f..68c0a31 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,8 @@ Welcome to PDP's documentation! =============================== +This is an implementation of an online judge. +The portal can be used for conducting programming contests as well as managing assignments in a university. +Apart from the facilities of usual programming contest portals, this portal provides facilities which are well suited for assignment submission. .. toctree:: :maxdepth: 2