Skip to content

Commit

Permalink
Update readme (#448)
Browse files Browse the repository at this point in the history
Changes to README

part of #393 

[skip ci]
  • Loading branch information
Franko1307 authored and ivotron committed Aug 13, 2018
1 parent 45d6bdd commit c8f3a5c
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
@@ -1,8 +1,8 @@
# Popper

[![Build Status](https://travis-ci.org/systemslab/popper.svg?branch=master)](https://travis-ci.org/systemslab/popper) [![Join the chat at https://gitter.im/systemslab/popper](https://badges.gitter.im/systemslab/popper.svg)](https://gitter.im/falsifiable-us/popper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![PyPI version](https://badge.fury.io/py/popper.svg)](https://badge.fury.io/py/popper) [![GitHub license](https://img.shields.io/github/license/systemslab/popper.svg)](https://github.com/systemslab/popper/blob/master/LICENSE)
[![Popper Status](http://badges.falsifiable.us/systemslab/popper)](http://popper.rtfd.io/en/latest/sections/badge_server.html)
# Popper [![Build Status](https://travis-ci.org/systemslab/popper.svg?branch=master)](https://travis-ci.org/systemslab/popper) [![Join the chat at https://gitter.im/systemslab/popper](https://badges.gitter.im/systemslab/popper.svg)](https://gitter.im/falsifiable-us/popper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![PyPI version](https://badge.fury.io/py/popper.svg)](https://badge.fury.io/py/popper) [![GitHub license](https://img.shields.io/github/license/systemslab/popper.svg)](https://github.com/systemslab/popper/blob/master/LICENSE) [![Popper Status](http://badges.falsifiable.us/systemslab/popper)](http://popper.rtfd.io/en/latest/sections/badge_server.html)

<p align="center" style="text-align:center;">
<img src="https://github.com/systemslab/popper/raw/master/docs/figures/popper_logo.png" width="200" />
</p>

Popper is a convention and CLI tool for generating reproducible papers. This repository contains:

Expand All @@ -12,14 +12,15 @@ Popper is a convention and CLI tool for generating reproducible papers. This rep
convention and the CLI tool.
* Contents of our [landing page](http://falsifiable.us) ([`gh-pages`](https://github.com/systemslab/popper/tree/gh-pages) branch).

Quick links to other resources:

Quick links to other resources:
* [5-minute screencast demo of the CLI](https://asciinema.org/a/xzEYfI3U4H5CWdmjBe0O2CAw8).
* [Slidedeck introducing the convention](https://www.slideshare.net/ivotron/the-popper-experimentation-protocol-and-cli-tool-86987253).
* [10-min video recording of intro and demo](https://air.mozilla.org/mozilla-open-leaders-round-4-final-demos-open-succulent-project/#@52m0s).
* [Software Carpentry formatted Lesson](https://popperized.github.io/swc-lesson/).
* [List of repositories that follow the convention](https://github.com/popperized).


## Installation

See [here](cli/) for instructions on how to install the CLI tool. Once
Expand All @@ -32,6 +33,7 @@ popper --help

For a quickstart guide on how to use the CLI, look [here](http://popper.readthedocs.io/en/latest/protocol/getting_started.html#quickstart-guide).


## Contributing

Anyone is welcome to contribute to Popper! To get started, take a look
Expand Down

0 comments on commit c8f3a5c

Please sign in to comment.