#19846: Beautify README for plaintext to markdown for github
-------------------------------------+-------------------------------------
Reporter: karandesai-96 | Owner: karandesai-96
Type: enhancement | Status: needs_work
Priority: trivial | Milestone: sage-wishlist
Component: documentation | Resolution:
Keywords: README, markdown, | Merged in:
github | Reviewers: Thierry Monteil
Authors: Karan Desai | Work issues:
Report Upstream: None of the above | Commit:
- read trac for reasoning. | 3124825c8db583d9f352e5338736a7821ec49fe4
Branch: | Stopgaps:
u/karandesai-96/beautify_readme |
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by karandesai-96):
Replying to [comment:16 tmonteil]:
Hi @tmonteil,
I have done the task as you asked to.
Please do have a look:
[https://github.com/karandesai-96/sage/tree/t/19846/beautify_readme
https://github.com/karandesai-96/sage/tree/t/19846/beautify_readme]
Raw content of MarkDown (.md) version:
[https://raw.githubusercontent.com/karandesai-96/sage/t/19846/beautify_readme/README.md
https://raw.githubusercontent.com/karandesai-96/sage/t/19846/beautify_readme/README.md]
Raw content of PlainText (.txt) version:
https://raw.githubusercontent.com/sagemath/sage/master/README.txt
Please compare the readability of raw content of both the versions and let
me know your thoughts ! :)
I hope the recent two commits pushed by me have improved the readability
of the markdown file viewed in plaintext.
Regards,
Karan
> You should keep in mind that most people will read this file while
opening the source tarball, not via github, so it has to be readable as a
(non-markdown) text file as well. In particular, you should indent the
text so that it is easy to identify/skip some paragraphs, and indent the
pieces of code even more so that it does not break the reading.
--
Ticket URL: <http://trac.sagemath.org/ticket/19846#comment:19>
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.
