shikhar9820/coff

Minor_Project2

COFF

Offline Judge for Competitive Coding

---

How to run this Project?

1. Clone the Repository.
2. Switch to master branch.
3. To build the project, enter make.
4. Run ./coff .
5. To remove the program compiled in step 3, enter make clean .

---

Start with Coff

As soon as a person builds Coff using make, an example question is saved to ~/coff/quest directory, with name "example1.quest" .

You can see the question by running:

./coff -s example1.quest

Write a program for it and save it ~/coff/ans. Lets say you made "1.c". Type:

./coff -q example1.quest -l c -t 1.c

All program files must be saved inside ~/coff/ans or as in the path specified in configuration file, else provide full path to your profram.

One can also find sample C/C++, Python and Javascript programs which were used in testing of Coff. They are in test_programs/ directory.

---

How to write questions?

1. Follow till Step 2 of "How to run this Project?"
2. Enter make coff-quest.
3. Run ./coff-quest.
4. To remove the program compiled in step 2, enter make clean.

---

How to reset configuration file?

1. Run make coff-config.

---

Documentation

To see user, documentation, run:

./coff -d

or

./coff --doc

---

Core Developers/ Contributors

1. Shikhar Kataruka
2. Shivam Khurana
3. Shreya Sneha
4. Vaibhav Gupta

---

coff's Issues

Developer Guide

Add a guide/documentation for developers.

Correct the Coding Style

The coding style is mentioned in Developers Guide. One need to check whole source code to see if incorrect coding style is used anywhere and then correct it and send a PR.

Implementation of Test Run

• The C/C++ programs are compiled with name "coff_testing" and stored in "~/coff/null" directory.
• Java files are compiled with their name.
• If files are to be interpreted, they should be copied into ~/coff/null directory.

Now run those executable files and test them.

Add software/system design in the developer documentation.

To understand the working flow of project

Grammar and Spelling

Check for grammatical/spelling mistakes in printf(), documentation and comments. Correct wherever necessary and send a PR.