Discussion:
[Matlab-emacs-discuss] the README file.
Uwe Brauer
2016-03-12 19:14:07 UTC
Permalink
Hi

I just upgraded (a bit) the README file and changed its format to
README.org since this is a very popular package and makes reading and
writing the file easier. However I could also

- provide README.md the markdown version, which is may be more
suited for github.

- in addition just the simple README file.

The later seems to me a slight overkill,

Opinions please.

Uwe Brauer
Torben Knudsen
2016-03-14 06:36:47 UTC
Permalink
I use org daily so I am happy with org. However, I newer met anybody else that uses org. I don't know the md format.

Associate Prof. Ph.D Torben Knudsen Mobile : (+45) 2787 9826
Section of Automation and Control,
Department of Electronic Systems, Email : ***@es.aau.dk
Aalborg University Web : es.aau.dk/staff/tk
Fredrik Bajersvej 7
DK-9220 Aalborg Ø
Denmark

________________________________________
Fra: Uwe Brauer [***@mat.ucm.es]
Sendt: 12. marts 2016 20:14
Til: matlab-emacs
Emne: [Matlab-emacs-discuss] the README file.

Hi

I just upgraded (a bit) the README file and changed its format to
README.org since this is a very popular package and makes reading and
writing the file easier. However I could also

- provide README.md the markdown version, which is may be more
suited for github.

- in addition just the simple README file.

The later seems to me a slight overkill,

Opinions please.

Uwe Brauer

------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with
Intel Data Analytics Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785111&iu=/4140
_______________________________________________
Matlab-emacs-discuss mailing list
Matlab-emacs-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/matlab-emacs-discuss
Alan Frankel
2016-03-15 14:54:58 UTC
Permalink
I use org. However, it makes sense to use Markdown format for the file, since that's standard procedure on GitHub. If you can learn org, you can definitely learn Markdown. One introduction can be found at Daring Fireball:

https://daringfireball.net/projects/markdown/basics

and if you do an Internet search for "GitHub Help Markdown", you'll find information about the "GitHub flavored" variant, though you probably don't need to worry about that.

-----Original Message-----
From: Torben Knudsen [mailto:***@es.aau.dk]
Sent: Monday, March 14, 2016 2:37 AM
To: Uwe Brauer <***@mat.ucm.es>; matlab-emacs <matlab-emacs-***@lists.sourceforge.net>
Subject: Re: [Matlab-emacs-discuss] the README file.

I use org daily so I am happy with org. However, I newer met anybody else that uses org. I don't know the md format.

Associate Prof. Ph.D Torben Knudsen Mobile : (+45) 2787 9826
Section of Automation and Control,
Department of Electronic Systems, Email : ***@es.aau.dk
Aalborg University Web : es.aau.dk/staff/tk
Fredrik Bajersvej 7
DK-9220 Aalborg Ø
Denmark

________________________________________
Fra: Uwe Brauer [***@mat.ucm.es]
Sendt: 12. marts 2016 20:14
Til: matlab-emacs
Emne: [Matlab-emacs-discuss] the README file.

Hi

I just upgraded (a bit) the README file and changed its format to README.org since this is a very popular package and makes reading and writing the file easier. However I could also

- provide README.md the markdown version, which is may be more
suited for github.

- in addition just the simple README file.

The later seems to me a slight overkill,

Opinions please.

Uwe Brauer

------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with Intel Data Analytics Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785111&iu=/4140
_______________________________________________
Matlab-emacs-discuss mailing list
Matlab-emacs-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/matlab-emacs-discuss

------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with Intel Data Analytics Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785231&iu=/4140
_______________________________________________
Matlab-emacs-discuss mailing list
Matlab-emacs-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/matlab-emacs-discuss
dl
2016-03-16 19:34:29 UTC
Permalink
github understands README.org as readme. no need to use markdown. Example:
https://github.com/jkitchin/org-ref/blob/master/README.org
<https://github.com/jkitchin/org-ref>
Post by Alan Frankel
I use org. However, it makes sense to use Markdown format for the file,
since that's standard procedure on GitHub. If you can learn org, you can
https://daringfireball.net/projects/markdown/basics
and if you do an Internet search for "GitHub Help Markdown", you'll find
information about the "GitHub flavored" variant, though you probably don't
need to worry about that.
-----Original Message-----
Sent: Monday, March 14, 2016 2:37 AM
Subject: Re: [Matlab-emacs-discuss] the README file.
I use org daily so I am happy with org. However, I newer met anybody else
that uses org. I don't know the md format.
Associate Prof. Ph.D Torben Knudsen Mobile : (+45) 2787 9826
Section of Automation and Control,
Aalborg University Web : es.aau.dk/staff/tk
Fredrik Bajersvej 7
DK-9220 Aalborg Ø
Denmark
________________________________________
Sendt: 12. marts 2016 20:14
Til: matlab-emacs
Emne: [Matlab-emacs-discuss] the README file.
Hi
I just upgraded (a bit) the README file and changed its format to
README.org since this is a very popular package and makes reading and
writing the file easier. However I could also
- provide README.md the markdown version, which is may be more
suited for github.
- in addition just the simple README file.
The later seems to me a slight overkill,
Opinions please.
Uwe Brauer
------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with Intel Data Analytics
Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785111&iu=/4140
_______________________________________________
Matlab-emacs-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/matlab-emacs-discuss
------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with Intel Data Analytics
Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785231&iu=/4140
_______________________________________________
Matlab-emacs-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/matlab-emacs-discuss
------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with
Intel Data Analytics Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785231&iu=/4140
_______________________________________________
Matlab-emacs-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/matlab-emacs-discuss
Uwe Brauer
2016-03-16 20:27:50 UTC
Permalink
------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with
Intel Data Analytics Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785231&iu=/4140

Loading...