Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation on building #46

Open
dontech opened this issue Oct 29, 2023 · 3 comments
Open

Update documentation on building #46

dontech opened this issue Oct 29, 2023 · 3 comments

Comments

@dontech
Copy link
Collaborator

dontech commented Oct 29, 2023

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
Copy link
Owner

mcuee commented Feb 19, 2024

@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
Copy link
Collaborator Author

dontech commented Feb 19, 2024

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 ?

@mcuee
Copy link
Owner

mcuee commented Feb 19, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants