#19846: Beautify README for plaintext to markdown for github
-------------------------+-------------------------------------------------
   Reporter:             |            Owner:  karandesai-96
  karandesai-96          |           Status:  new
       Type:             |        Milestone:  sage-wishlist
  enhancement            |         Keywords:  README, markdown, github
   Priority:  trivial    |          Authors:  Karan Desai
  Component:  misc       |  Report Upstream:  None of the above - read trac
  Merged in:             |  for reasoning.
  Reviewers:             |           Branch:  karandesai-96-readme-beautify
Work issues:             |     Dependencies:
     Commit:             |
   Stopgaps:             |
-------------------------+-------------------------------------------------
 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.

--
Ticket URL: <http://trac.sagemath.org/ticket/19846>
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.

Reply via email to