https://github.com/invernizzi/Chrisper

Detect common mistakes in academic papers
https://github.com/invernizzi/Chrisper

Last synced: 2 months ago
JSON representation

Detect common mistakes in academic papers

• Host: GitHub
• URL: https://github.com/invernizzi/Chrisper
• Owner: invernizzi
• Created: 2012-03-19T15:42:14.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2019-03-01T17:44:38.000Z (almost 6 years ago)
• Last Synced: 2024-08-01T03:14:24.220Z (5 months ago)
• Language: Python
• Homepage:
• Size: 146 KB
• Stars: 58
• Watchers: 4
• Forks: 11
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-thesis - Chrisper

README

        
Chrisper: Check the style of your papers

========================================

Chrisper is a small utility that checks for common mistakes in the latex source of Computer Science papers.

The reference that we follow is [Bugs in Writing](http://www.amazon.com/BUGS-Writing-Revised-Guide-Debugging/dp/020137921X).

Install

-------

The only dependencies are "detex", which you can install

on a Debian derivative system with:

    sudo apt-get install texlive-extra-utils

and "nltk", which you can install with:

    sudo pip install nltk

If you want to be fancy and have the (optional) colored output,

     sudo pip install clint

Add chrisper in you path to use it, or copy it directly in

the root path of you awesome paper.

Usage

-----

 

    chrisper *.tex

Example

-------

An run of Chrisper on [this_tex_file](example_with_errors.tex) gives this output:

![Alt text](example_with_errors.png)

Contributing

------------

You're more than welcome :)

Related Work

-----------

* [some shell scripts](http://matt.might.net/articles/shell-scripts-for-passive-voice-weasel-words-duplicates/)

* [WDS](https://github.com/utapyngo/WritingSmellDetector)

* [stile-check.rb](http://www.cs.umd.edu/~nspring/software/style-check-readme.html)