exercism / development-environment

16 stars 19 forks source link

Update readme #12

Closed iHiD closed 4 years ago

iHiD commented 4 years ago

I've fleshed out the README with some more info about how to use this repository.

There are other more advanced config options we should document, but I believe this forms a good starting point.

iHiD commented 4 years ago

@joshgoebel - Have I got everything right? Missed anything obvious?

I also want us to standardise the locations/names of the run-tests etc scripts across repos, so we can reference those here, but that's a secondary thing.

SaschaMann commented 4 years ago

Could you add some system/storage requirements? Last time I tried building it, it was fairly big and knowing that in advance would have prevented some issues; and I've also run into situations where a Docker image runs out of memory on the default settings.

iHiD commented 4 years ago

@SleeplessByte @SaschaMann @neenjaw Thank you all :) I shall merge this. Please feel free to PR and changes (or open issues for further changes).

joshgoebel commented 4 years ago

@SaschaMann I don't know exactly, but the new stack should use less RAM and storage than the old stack by a noticeable amount. Trying to catch up now. :)

joshgoebel commented 4 years ago

Awesome job everyone who works on the documentation here. It's a HUGE improvement all around.

neenjaw commented 4 years ago

@joshgoebel I'm not sure I understand your reply since I think my only question was about the dev.Dockerfile locstion. Was that in response to @saschamann's question about resources?

joshgoebel commented 4 years ago

Yeah, sorry. Corrected.

I left one question to clarify the location of the dev.Dockerfile file. This will be a great resource.

Well, I'm not sure we have any solid "pattern" on this yet... and the only Dockerfile that actually is included with this repo is the "setup" one, which is why it's in the setup folder. There isn't really a Dockerfiles for "compose" itself... or I'm not understanding your question?

neenjaw commented 4 years ago

I left one question to clarify the location of the dev.Dockerfile file. This will be a great resource.

Well, I'm not sure we have any solid "pattern" on this yet... and the only Dockerfile that actually is included with this repo is the "setup" one, which is why it's in the setup folder. There isn't really a Dockerfiles for "compose" itself... or I'm not understanding your question?

For sure, my question was in response to my comment (now resolved with a commit) for line 102. As I understand it, there is a dev.Dockerfile in each stack-component's repository, and it was just a clarification of that statement. Which is then used by start up script here to build the desired stack.

I think my question is answered. :)