Skip to content

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

Merged
merged 7 commits into from
Nov 10, 2020
Merged

Clean up README #586

merged 7 commits into from
Nov 10, 2020

Conversation

safinsingh
Copy link
Contributor

List of Changes

  • Various grammar fixes and other visual stuff.

Motivation

  • manimce has approached v0.1.0, and I believe it's appropriate to update this accordingly.

Explanation for Changes

  • Sentence structure, misc. visual additions.

Acknowledgement

@safinsingh
Copy link
Contributor Author

@leotrs
Copy link
Contributor

leotrs commented Oct 22, 2020

The image under "usage" also needs to be updated to use the new -ql flag

@safinsingh
Copy link
Contributor Author

I believe @cobordism had a new image?

@cobordism
Copy link
Member

I believe @cobordism had a new image?

#572 (comment)
(it's the code to generate a new image and a link to an already rendered one in discord chat)

@kolibril13
Copy link
Member

I believe @cobordism had a new image?

#572 (comment)
(it's the code to generate a new image and a link to an already rendered one in discord chat)

There was still a small mistake, I updated the code for producing the banner here:
#572 (comment)
The previous version had no CamelCase.

@kolibril13
Copy link
Member

Thanks for improving these things!
[Non-Blocking] Personally, I find it more appealing to have Manim instead of manim in the text.

@behackl behackl added the documentation Improvements or additions to documentation label Oct 24, 2020
Comment on lines +5 to +9
<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" />
Copy link
Member

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.

@behackl behackl added this to the Release v0.1.1 milestone Oct 31, 2020
@behackl behackl linked an issue Oct 31, 2020 that may be closed by this pull request
@behackl
Copy link
Member

behackl commented Oct 31, 2020

It would be great if we could move this forward and in particular exchange the outdated command line flag (#572). @safinsingh?

@safinsingh
Copy link
Contributor Author

Sure, I'll try to get to this ASAP.

@leotrs
Copy link
Contributor

leotrs commented Nov 9, 2020

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.

@kolibril13
Copy link
Member

image
I think this new banner is still missing?

@leotrs
Copy link
Contributor

leotrs commented Nov 9, 2020 via email

@kolibril13
Copy link
Member

Done.

@kolibril13
Copy link
Member

image
And there are some redundant files that exists in readme-asserts AND in docs _static.
As they are only used in docs _static, I will remove them in readme-asserts

@kolibril13
Copy link
Member

In case that there are no concerns in removing readme-asserts, I will merge this tomorrow morning

@leotrs
Copy link
Contributor

leotrs commented Nov 9, 2020

I'm in favor of removing anything that's not in use.

@kolibril13
Copy link
Member

Ok, then I will merge this now

@kolibril13 kolibril13 merged commit 6addecc into master Nov 10, 2020
@kolibril13 kolibril13 deleted the readme-cleanup branch November 10, 2020 12:28
@eulertour
Copy link
Member

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.

@kolibril13
Copy link
Member

@eulertour : as this is already merged, do you want to make a follow up pr on that? :)

@naveen521kk
Copy link
Member

naveen521kk commented Nov 10, 2020

Also, I could see some relative links of image which must be replaced because they dont work on PyPi.

@behackl
Copy link
Member

behackl commented Nov 10, 2020

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.

@kolibril13
Copy link
Member

Also, I could see some relative links of image which must be replaced because they dont work on PyPi.

Sorry for that, that was my fault. @behackl : thanks for fixing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecated CLI flag is advertised on our github front page
7 participants