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.
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
Update readme #448
Merged
Merged
Update readme #448
Changes from 5 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
2c83011
Add logo
Franko1307 6b30e08
Add screencast
Franko1307 8785998
little update
Franko1307 910ff8c
little update [ci skip]
Franko1307 7f79290
little update [ci skip]
Franko1307 0077f18
Changes [ci skip]
Franko1307 4361242
Changes [ci skip]
Franko1307 216e0b2
Add rsz_popper_logo [ci skip]
Franko1307 f91c72f
[ci skip requested changes]
Franko1307 c4032f5
[ci skip] Reduces size of logo
Franko1307 6356655
[ci skip] Reduces size of logo
Franko1307 1f4988d
[ci skip] Removes video
Franko1307 File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
# Popper | ||
<img src="docs/figures/popper_logo.png" width="200"> | ||
|
||
# | ||
|
||
[![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) | ||
|
@@ -14,12 +16,15 @@ Popper is a convention and CLI tool for generating reproducible papers. This rep | |
|
||
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). | ||
|
||
#### 5 minute screencast demo of the CLI | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it will be better if the screencast can be moved above the quick links section. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree. I made the changes. |
||
|
||
[![asciicast](https://asciinema.org/a/xzEYfI3U4H5CWdmjBe0O2CAw8.png)](https://asciinema.org/a/xzEYfI3U4H5CWdmjBe0O2CAw8) | ||
|
||
## Installation | ||
|
||
See [here](cli/) for instructions on how to install the CLI tool. Once | ||
|
@@ -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 | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can be changed to the markdown syntax instead of mixing html and markdown.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah sure, the problem with the Markdown syntax is that it doesn't support a size parameter on GitHub. Take a look of how the logo looks like and if you're okay with the size I'll use that syntax. Or if you know a way to change the size using the Markdown syntax please let me know.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is simple. You can use a resized logo instead. You can just resize it and add a
small_logo.png
or something like that and then use it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess you're right. I made the changes 😄