Skip to content
This repository has been archived by the owner on Dec 4, 2017. It is now read-only.

Commit

Permalink
Added screenshot and improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasmartinelli committed Dec 4, 2014
1 parent 5eb6984 commit 78a6e88
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# delptr [![Build Status](https://travis-ci.org/lukasmartinelli/delptr.svg)](https://travis-ci.org/lukasmartinelli/delptr) ![Dependencies](https://david-dm.org/lukasmartinelli/delptr.svg) [![Code Climate](https://codeclimate.com/github/lukasmartinelli/delptr/badges/gpa.svg)](https://codeclimate.com/github/lukasmartinelli/delptr)
# delptr [![Build Status](https://travis-ci.org/lukasmartinelli/delptr.svg)](https://travis-ci.org/lukasmartinelli/delptr) ![Dependencies](https://david-dm.org/lukasmartinelli/delptr.svg) [![Code Climate](https://codeclimate.com/github/lukasmartinelli/delptr/badges/gpa.svg)](https://codeclimate.com/github/lukasmartinelli/delptr) [![Coverage Status](https://img.shields.io/coveralls/lukasmartinelli/delptr.svg)](https://coveralls.io/r/lukasmartinelli/delptr?branch=master)

Realtime linting of C++ projects on Github.
Listen to all push events of C++ projects on Github and run some simple linting, to check
whether the people still manage memory on their own instead of using smart pointers.

If someone still uses `new` and `delete` in their code they appear in realtime on the
site.

![Realtime linting of C++ projects](screenshot.gif)

## Install

Expand All @@ -12,10 +18,27 @@ npm install

## Run

Run the server with an optional Github Access Token.
Please be aware that this will download alot of data.
Run the server with an optional Github access token.
Please be aware that this will download alot of data if you don't provide
a Github access token.

```
export GITHUB_ACCESS_TOKEN=asb1234gwa...
node server.js $GITHUB_ACCESS_TOKEN
npm start $GITHUB_ACCESS_TOKEN
```

Now you can visit `localhost:3000` to see the realtime linting in action.

## Build

You need gulp to run the tests.

```
npm install -g gulp
```

Now you can execute the tests and lint the project.

```
gulp
```
Binary file added screenshot.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 78a6e88

Please sign in to comment.