windows readme needs updating #1301

Closed
bilderbuchi opened this Issue Jun 3, 2012 · 13 comments

Comments

Projects
None yet
4 participants
Owner

bilderbuchi commented Jun 3, 2012

See here
OSX readme needs a correction in this section - paths are wrong, workflow maybe too?

Contributor

kylemcdonald commented Jun 3, 2012

yes, let's do a pass of updating all readmes before the next release. good catch.

Contributor

keeran commented Aug 5, 2012

Wasn't sure how to make the comparison with the app directory structure, had a go

#1451

Contributor

kylemcdonald commented Aug 5, 2012

thanks keeran, that brings osx up to date.

if someone could check the other platforms that would be perfect.

Owner

bilderbuchi commented Sep 3, 2012

So, Linux has been updated, only Windows is left :-)

Contributor

kylemcdonald commented Oct 1, 2012

@gameoverhack or @elliotwoods do you think you could check that the readme is still accurate (or inaccurate) it is since the last changes from 007?

Owner

bilderbuchi commented Oct 2, 2012

So, as this is one of the two issues open for 0072, is there anyone else currently familiar enough with the Windows workflow to give the Readme a once-over? @ALL would really come in handy here :D

Contributor

elliotwoods commented Oct 2, 2012

hey i'm online
will have a look now

Contributor

elliotwoods commented Oct 2, 2012

so i see there is no readme.vs
does this mean that we just need vs readme creating
or that we also need cb updating?

Owner

bilderbuchi commented Oct 2, 2012

both I'd wager.

Contributor

elliotwoods commented Oct 2, 2012

wait. is the readme supposed to direct people to PG or emptyExample?

Contributor

elliotwoods commented Oct 2, 2012

presuming we can't use markdown in a way that compromising plain-text reading, right?

Contributor

kylemcdonald commented Oct 2, 2012

regarding PG vs emptyExample, that's a good question for @ofZach to answer.

i think if you write it using the old style (emptyExample oriented) that's good, maybe adding a few notes at the bottom that the PG is included but still very experimental.

also, correct: the readmes have not historically use markdown syntax. just very minimal text description.

Owner

bilderbuchi commented Oct 3, 2012

@kylemcdonald @elliotwoods I'm not sure I understand elliot's question right, but imo we could use markdown now (and I'd argue for it), since it's quite well readable even in plaintext mode in a text editor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment