-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Clean up README #586
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
Clean up README #586
Conversation
The image under "usage" also needs to be updated to use the new -ql flag |
I believe @cobordism had a new image? |
#572 (comment) |
There was still a small mistake, I updated the code for producing the banner here: |
Thanks for improving these things! |
<img src="https://img.shields.io/badge/license-MIT-red.svg?style=flat" alt="MIT License" src="http://choosealicense.com/licenses/mit/" /> | ||
<img src="https://img.shields.io/reddit/subreddit-subscribers/manim.svg?color=orange&label=reddit" alt="Reddit" href="https://www.reddit.com/r/manim/" /> | ||
<img src="https://img.shields.io/discord/581738731934056449.svg?label=discord&color=yellow" alt="Discord" href="https://discord.gg/mMRrZQW" /> | ||
<img src="https://readthedocs.org/projects/manimce/badge/?version=latest" alt="Documentation Status" href="https://manimce.readthedocs.io/en/latest/?badge=latest" /> | ||
<img src="https://github.com/ManimCommunity/manim/workflows/CI/badge.svg" alt="CI" /> |
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'd consider the fact that the CI is is passing and the docs are building to be more immediately useful to visitors than the license and social links, so I prefer the old order.
Additionally, it's odd for the reddit link to be orange rather than red and for the discord link to be yellow rather than green (which is a standard "working" color) or blue (which is part of discords branding). The change of the MIT button is a little better, but I don't really see any reason to change it from the standard blue used on shields.io.
It would be great if we could move this forward and in particular exchange the outdated command line flag (#572). @safinsingh? |
Sure, I'll try to get to this ASAP. |
I have manually committed all suggestions I was able to see. @behackl can you please confirm that the current status looks good to you, and if so merge this PR? It doesn't have to be perfect, but it's kinda silly that this PR has been open for this long. |
Ah good point. I'm busy today, but if anyone has time to add the new
picture and merge this, that'd be greatly appreciated.
…On Mon, Nov 9, 2020 at 4:04 AM kolibril13 ***@***.***> wrote:
[image: image]
<https://user-images.githubusercontent.com/44469195/98520786-d92aa980-2272-11eb-937c-e5c92b0b0858.png>
I think this new banner is still missing?
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#586 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAILYAD4ICIJ2B77XB24GL3SO6WA3ANCNFSM4S2URUCQ>
.
--
www.leotrs.com | leo@leotrs.com
PhD candidate at the Network Science Institute, Northeastern University
|
Done. |
In case that there are no concerns in removing readme-asserts, I will merge this tomorrow morning |
I'm in favor of removing anything that's not in use. |
Ok, then I will merge this now |
The colors on the buttons still don't make much sense. The reddit and discord links are neither their respective brand colors nor a default color like blue. The new ordering is odd too since the license, which isn't useful to most people, is listed first, and the documentation and CI status are last. |
@eulertour : as this is already merged, do you want to make a follow up pr on that? :) |
Also, I could see some relative links of image which must be replaced because they dont work on PyPi. |
As a heads up: I added another badge over at #681 and fixed the broken links introduced here. I would appreciate if we could merge that at some point soon, if possible before further changes are made on a follow-up PR. |
Sorry for that, that was my fault. @behackl : thanks for fixing this! |
List of Changes
Motivation
manimce
has approached v0.1.0, and I believe it's appropriate to update this accordingly.Explanation for Changes
Acknowledgement