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.

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 12 commits into from Aug 13, 2018
Merged

Update readme #448

merged 12 commits into from Aug 13, 2018

Conversation

Franko1307
Copy link
Contributor

update README
add logo
add screencast to README
update links

addresses #393

@Franko1307 Franko1307 self-assigned this Aug 3, 2018
@Franko1307 Franko1307 requested a review from ivotron August 3, 2018 21:40
README.md Outdated
@@ -1,4 +1,6 @@
# Popper
<img src="docs/figures/popper_logo.png" width="200">
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor Author

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 😄

README.md Outdated
* [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
Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree. I made the changes.

Copy link
Contributor

@ankan17 ankan17 left a comment

Choose a reason for hiding this comment

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

Looking good :)

README.md Outdated

#### 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.

README.md Outdated
# 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

@ivotron ivotron merged commit c096d92 into master Aug 13, 2018
@ivotron ivotron deleted the update-readme branch August 13, 2018 15:53
ivotron pushed a commit that referenced this pull request May 24, 2020
Changes to README

part of #393 

[skip ci]
ivotron pushed a commit that referenced this pull request May 25, 2020
Changes to README

part of #393 

[skip ci]
ivotron pushed a commit that referenced this pull request May 25, 2020
Changes to README

part of #393 

[skip ci]
ivotron pushed a commit that referenced this pull request May 25, 2020
Changes to README

part of #393 

[skip ci]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants