mcuee/libusb-win32

Update documentation on building

dontech opened this issue · 3 comments

dontech commented

As pointed out, the current documentation is either wrong or lacking.

At least detail how to:

  1. Build using Visual Studio
  2. Build using command line "build.cmd"
mcuee commented

@dontech

Do you want to create a new BUILD.md file in the repo? Or we can just update the Wiki to replace the outdated info with the latest info?
https://github.com/mcuee/libusb-win32/wiki#user-content-Development

dontech commented

Well we probably need to update the wiki anyway, or remove it.

I am kind of old-school so I was thinking of having the documentation inside the repo, so that the documentation lives with the source no matter where it is.

To keep it simple can't we just have a readme.md to put everything that was in wiki, and then update that to match current setup ?

  • 👍1
mcuee commented

Well we probably need to update the wiki anyway, or remove it.

I am kind of old-school so I was thinking of having the documentation inside the repo, so that the documentation lives with the source no matter where it is.

To keep it simple can't we just have a readme.md to put everything that was in wiki, and then update that to match current setup ?

Good idea. I think we can start with the Wiki.

I will suggestion that we keep the following three sections in the Wiki and then move the rest to README.md.