Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme #448

Merged
merged 12 commits into from Aug 13, 2018
Merged

Update readme #448

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2c83011
Add logo
Franko1307 Aug 3, 2018
6b30e08
Add screencast
Franko1307 Aug 3, 2018
8785998
little update
Franko1307 Aug 3, 2018
910ff8c
little update [ci skip]
Franko1307 Aug 3, 2018
7f79290
little update [ci skip]
Franko1307 Aug 3, 2018
0077f18
Changes [ci skip]
Franko1307 Aug 7, 2018
4361242
Changes [ci skip]
Franko1307 Aug 7, 2018
216e0b2
Add rsz_popper_logo [ci skip]
Franko1307 Aug 8, 2018
f91c72f
[ci skip requested changes]
Franko1307 Aug 12, 2018
c4032f5
[ci skip] Reduces size of logo
Franko1307 Aug 12, 2018
6356655
[ci skip] Reduces size of logo
Franko1307 Aug 12, 2018
1f4988d
[ci skip] Removes video
Franko1307 Aug 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
@@ -1,9 +1,8 @@
# Popper

![popper logo](docs/figures/rsz_popper_logo.png)
#
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we reduce the size of the image and/or center it? Also, having the badges next to the title of the project (like the hashicorp projects), and then the logo something like:

Popper Build Status Join the chat at https://gitter.im/systemslab/popper PyPI version GitHub licensePopper Status

Popper is a convention and CLI tool for generating reproducible papers...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be okay now @ivotron

[![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 is a convention and CLI tool for generating reproducible papers. This repository contains:

* A [CLI tool](popper/) to help bootstrap research articles that
Expand All @@ -12,14 +11,20 @@ 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).


#### 5 minute screencast demo of the CLI

[![asciicast](https://asciinema.org/a/xzEYfI3U4H5CWdmjBe0O2CAw8.png)](https://asciinema.org/a/xzEYfI3U4H5CWdmjBe0O2CAw8)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can the size of the image be reduced?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be better to leave it out as we had it before. Or to reduce the size of it and put it to the end.



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 +37,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
Binary file added docs/figures/rsz_popper_logo.png
View file
Open in desktop
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.