opendylan icon indicating copy to clipboard operation
opendylan copied to clipboard

opendylan2019 README

Open zbyszek2019 opened this issue 6 years ago • 5 comments

README talks about opendylan2014 in some places (e.g. directory paths :-)

ZJ

zbyszek2019 avatar May 30 '19 10:05 zbyszek2019

It's unfortunate that things like that happen during releases. FWIW the compiler thinks that it's 2019:

// from ./sources/lib/release-info/common-info.dylan
define constant $release-version            = "2019.1";

timClicks avatar Jul 10 '19 10:07 timClicks

For the record we're talking about https://github.com/dylan-lang/opendylan/blob/master/build/packages/unix/README here. I guess there's no point fixing this until the next release though.

Note that the release checklist does mention updating that file, so this is "just" human error. Would be great to automate this a bit...

cgay avatar Jul 10 '19 22:07 cgay

In particular it would be nice if we could generate the README that gets included in the package from https://github.com/dylan-lang/opendylan/blob/master/README.rst

(I tried to investigate this but wasn't immediately able to find a recipe for doing single-file reStructuredText to plain text conversion.)

housel avatar Jul 10 '19 22:07 housel

(I tried to investigate this but wasn't immediately able to find a recipe for doing single-file reStructuredText to plain text conversion.)

Not sure if this helps: https://stackoverflow.com/questions/1192632/how-to-convert-restructuredtext-to-plain-text

  • First response with Sphinx TextBuilder
  • Second response with rst -> html -> w3m/lynx/links/elinks or html2txt -> txt but requires install additional programs.

fraya avatar Jul 30 '19 08:07 fraya

It seems to me these days the README need not be anything more than "welcome, and installation instructions are at https://github.com/dylan-lang/opendylan/blob/v2019.1.0/README.rst". (Note the URL is pegged to the specific release.) Is there a reasonable scenario where the user doesn't have network access anymore, presumably after just having downloaded the release?

(Obviously the README.rst would have to change a little.)

cgay avatar Aug 01 '19 21:08 cgay