#19846: Beautify README for plaintext to markdown for github
-------------------------------------+-------------------------------------
Reporter: karandesai-96 | Owner: karandesai-96
Type: enhancement | Status: needs_review
Priority: trivial | Milestone: sage-wishlist
Component: misc | Resolution:
Keywords: README, markdown, | Merged in:
github | Reviewers:
Authors: Karan Desai | Work issues:
Report Upstream: None of the above | Commit:
- read trac for reasoning. | 989d2fbabd061ac93b412254a6a253e3215b2752
Branch: | Stopgaps:
u/karandesai-96/beautify_readme |
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by karandesai-96):
Hi @nbruin
I wrapped the text in the Markdown version too, and I looks more cleaner
and appealing to the eye than before.
Have a look:
https://github.com/karandesai-96/sage/tree/t/19846/beautify_readme
The clutter in plaintext version of file was saved as I did not have to
put <br/> tags at the end of each line. Appending two blankspaces at the
end of line means a line break, in markdown! :)
The plaintext version is has two blank spaces after each line, but it
looks same:
https://raw.githubusercontent.com/karandesai-96/sage/t/19846/beautify_readme/README.md
I hope the README now serves both ways:
> It renders in a beautiful way, for the users on Github to view.
> It is retained readability in plain text format too, for another users.
Regards, Karan.
--
Ticket URL: <http://trac.sagemath.org/ticket/19846#comment:9>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
