Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mjnaderi committed Mar 27, 2015
1 parent 6e016b3 commit feb0920
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Sharif Judge

[Sharif Judge](http://sharifjudge.ir) is a free and open source online judge for C, C++, Java and
[Sharif Judge](https://github.com/mjnaderi/Sharif-Judge) is a free and open source online judge for C, C++, Java and
Python programming courses.

The web interface is written in PHP (CodeIgniter framework) and the main backend is written in BASH.

Python in Sharif Judge is not sandboxed yet. Just a low level of security is provided for python.
If you want to use Sharif Judge for python, USE IT AT YOUR OWN RISK or provide sandboxing yourself.

The full documentation is at [http://docs.sharifjudge.ir](http://docs.sharifjudge.ir)
The full documentation is at https://github.com/mjnaderi/Sharif-Judge/tree/docs

Download the latest release from [http://sharifjudge.ir/download](http://sharifjudge.ir/download)
Download the latest release from https://github.com/mjnaderi/Sharif-Judge/releases

## Features
* Multiple user roles (admin, head instructor, instructor, student)
Expand Down Expand Up @@ -41,20 +41,20 @@ For running Sharif Judge, a Linux server with following requirements is needed:

## Installation

1. Download the latest release from [download page](http://sharifjudge.ir/download) and unpack downloaded file in your public html directory.
1. Download the latest release from [download page](https://github.com/mjnaderi/Sharif-Judge/releases) and unpack downloaded file in your public html directory.
2. **[Optional]** Move folders `system` and `application` somewhere outside your public directory. Then save their full path in `index.php` file (`$system_path` and `$application_folder` variables).
3. Create a MySql or PostgreSql database for Sharif Judge. Do not install any database connection package for C/C++, Java or Python.
4. Set database connection settings in `application/config/database.php`.
5. Make `application/cache/Twig` writable by php.
6. Open the main page of Sharif Judge in a web browser and follow the installation process.
7. Log in with your admin account.
8. **[IMPORTANT]** Move folders `tester` and `assignments` somewhere outside your public directory. Then save their full path in `Settings` page. **These two folders must be writable by PHP.** Submitted files will be stored in `assignments` folder. So it should be somewhere not publicly accessible.
9. **[IMPORTANT]** [Secure Sharif Judge](http://docs.sharifjudge.ir/en:v1.4:security)
9. **[IMPORTANT]** [Secure Sharif Judge](https://github.com/mjnaderi/Sharif-Judge/blob/docs/v1.4/security.md)

## After Installation

* Read the [documentation](http://docs.sharifjudge.ir)
* Read the [documentation](https://github.com/mjnaderi/Sharif-Judge/tree/docs)

## License

GPL v3
GPL v3

0 comments on commit feb0920

Please sign in to comment.