#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: |
-------------------------------------+-------------------------------------
Changes (by karandesai-96):
* commit: => 989d2fbabd061ac93b412254a6a253e3215b2752
Old description:
> Most of the READMEs of Github repositories are markdown files (.md
> extension). Markdown files are rendered by Github and they look nicely
> formatted and better to the eye than plaintext files.
>
> The existing README.txt has to be converted to a README.md for better
> aesthetic look for users viewing Github repository, while preserving the
> readibility if viewed as a plaintext file.
>
> I have obtained a fork of the source and did the job in the separate
> branch :
> https://github.com/karandesai-96/sage/tree/karandesai-96-readme-beautify
> I will be glad to receive positive reviews.
New description:
Most of the READMEs of Github repositories are markdown files (.md
extension). Markdown files are rendered by Github and they look nicely
formatted and better to the eye than plaintext files.
The existing README.txt has to be converted to a README.md for better
aesthetic look for users viewing Github repository, while preserving the
readibility if viewed as a plaintext file.
--
Comment:
New commits:
||[http://git.sagemath.org/sage.git/commit/?id=eb27fa4fdfdb47a2599ae3229169a159de44e0f9
eb27fa4]||{{{Renamed README.txt to README.md and beautified it for
Github.}}}||
||[http://git.sagemath.org/sage.git/commit/?id=989d2fbabd061ac93b412254a6a253e3215b2752
989d2fb]||{{{Updated README.md to have better aesthetic feel on
github.}}}||
--
Ticket URL: <http://trac.sagemath.org/ticket/19846#comment:4>
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.
