Update docs to explain purpose of SampleProjects #156
Conversation
… that they are templates to be followed too closely.
…n't work on macOS 10.16). - Correct location for your project.
|
I started writing some inline comments, but I think it's more valuable to just have you rewrite docs as you see fit because that gives me an idea of what's unclear (and in what sense it's unclear). I will probably end up using whatever changes you add to this PR as a guide for beefing up these docs, and I'll have you take a look at my edits (in a separate PR) to see if they address what you're finding here. TL;DR, I don't get many opportunities to see this code through the eyes of a new user so please don't hold back -- I'll worry about smoothing it out at a later point |
|
That's fine. I'm happy to provide feedback in whatever manner seems easier for you. I appreciate the quick turn-around on the ideas and questions. I'm learning a lot, making good progress, and will have more submissions for your consideration soon. |
|
An unrelated matter (new issue?) but related to seeing things from the eyes of a new user: I struggled with the compile vs. unit test options for a while. I spent a lot of time struggling with the compiler to get the unit tests to work and the idea that I'm running the unit tests without compiling (them?) seems very odd. Now that I'm understanding better I wonder if "Compile Examples" would be a better phrase (even though it is more verbose). |
|
Lets's absolutely open that new issue. |
This should avoid the impression that they are templates to be followed too closely. This is a partial fix for #149.