Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This cleans up the WIKI docs, fixes broken links, and much of the grammar. And most importantly, brings the official docs into our repository so we can edit them and keep them in sync with the source code.
The docs for the tools are pretty solid at this point - I scoured the source code to make sure all of the command line options are in the documentation. Although, the usage examples for the tools probably need to be updated.
Most of the docs in the top level
docs/
directory still need to be updated for the .NET Core bits, which I could use some help with. There are several references to .NET Framework, GAC, Mono, renaming IKVM executables to Java executables, etc. that still need to be fixed. The biggest issues are in the following files:debugging.md
installation.md
tutorial.md
user-guide.md
Plus we are missing the following from the distribution (required for the tutorial).
hello.jar
I think we can probably condense the above into a single tutorial document and perhaps change the
installation.md
into atools/installation.md
document, since using the libraries is as simple now as using the NuGet package.Oddly, the
debugging.md
instructions use thevfs.zip
in order to enable Visual Studio debugging. However, we will probably need to comment out the whole section until we have support for portable.pdb
format.The following info is also missing from the current documentation:
ikvmc
on .NET Frameworkikvmc
on .NET CoreTargetFramworkAttribute
to the output assembly ofikvmc