SharpPad icon indicating copy to clipboard operation
SharpPad copied to clipboard

Improve Documentation

Open Joebeazelman opened this issue 3 years ago • 0 comments

It would be nice if you made the documentation a bit clearer.

In the first paragraph, you instruct the user to download and install the extension and the NuGet package, but it's not that simple. It requires more steps such as creating the project and creating the main CS file. You assume the user already understands what's required to make your product work. VSCode's configuration is very manual and there's no automatic configuration. There's also no clear standard developers follow.

The second paragraph is much better. You give clear and concise instructions and provide a good starting point. Unfortunately, your previous paragraph leaves the user thinking they need to install the NuGet package. Since many developers have already upgraded to at least .NET 5, there's a good chance they'll encounter compiler errors like I initially did as assume it's because they didn't download the NuGet package. The second paragraph should really be first.

Finally, you never describe how to execute the code and where to look for the output! I only figured out how to execute SharpPad by going to the run menu. I wasn't expecting the commands to be there, since most REPLs don't require a compile and a run.

Joebeazelman avatar Jul 30 '22 16:07 Joebeazelman