Skip to content

Commit

Permalink
Adding documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Dilawar Singh committed Dec 21, 2014
1 parent a253803 commit c77b873
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/code-sniffer.pandoc
Original file line number Diff line number Diff line change
@@ -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.


0 comments on commit c77b873

Please sign in to comment.