I mirror the SVN repo on https://github.com/fricas/fricas/

If there were a file README.rst (written in reStructuredText), then
Github displays it nicely formatted. I've just quickly produced examples
for FriCAS (that's unfinished).

https://github.com/hemmecke/fricas-ws/blob/master/README.rst

In particular see how the table of contents is automatically generated here.

https://github.com/hemmecke/fricas-ws/blob/master/INSTALL.rst

I've got my formatting examples mostly from here.

https://github.com/PyMySQL/PyMySQL/blob/master/README.rst

Raw file version here:
https://raw.githubusercontent.com/PyMySQL/PyMySQL/master/README.rst

Using a .rst Format would have the advantage, first, to display nicely
when people browse the code at github and second, I could take those
files and include them at https://fricas.github.io.

In other words, all out pure text files like README, INSTALL, FAQ should
be translated into reStructuredText. While this is done, the text in
these files should be revised. They simply become more visible/readable
over the web while still being nicely readable when viewed in a simple
text editor.

Opinions?
Who would like to help?

Ralf

-- 
You received this message because you are subscribed to the Google Groups 
"FriCAS - computer algebra system" 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].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/fricas-devel/512e3da0-bbdf-67aa-4fcc-5d267bf35e41%40hemmecke.org.
For more options, visit https://groups.google.com/d/optout.

Reply via email to