From c77b87395b34d11d13ad1f9f2480c713188ec3ee Mon Sep 17 00:00:00 2001
From: Dilawar Singh <dilawars@ncbs.res.in>
Date: Mon, 22 Dec 2014 03:28:09 +0530
Subject: [PATCH] Adding documentation.

---
 docs/code-sniffer.pandoc | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 docs/code-sniffer.pandoc

diff --git a/docs/code-sniffer.pandoc b/docs/code-sniffer.pandoc
new file mode 100644
index 0000000..fff0b06
--- /dev/null
+++ b/docs/code-sniffer.pandoc
@@ -0,0 +1,33 @@
+---
+title: The Code-Sniffer
+author: Dilawar Singh
+date : \today 
+header-includes:
+    - \usepackage[margin=15mm]{geometry}
+---
+
+## Abstract
+
+This document describes the python based project
+[code-sniffer](https://github.com/dilawar/code-sniffer). 
+
+## Introduction
+
+The code-sniffer sniffs code for plagiarism. It works on text files, and on pdf
+after converting them to text files. It works well on programming languages. See
+the [project page](https://dilawar.github.io/sniffer) for results.
+
+
+## Technical details
+
+This application compares files available in a user's directory with all files
+available in other user's directory. For $n$ users, each file of each user is
+compared with every other. In nutshell, its break down to compare two text files
+for copying which it does in following way:
+
+
+### Algorithm to check plagiarism 
+
+1. Read fileA and fileB.
+
+