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

Ununderstandable documents (wiki) #49

Open
naveennamani opened this issue Jan 4, 2019 · 6 comments
Open

Ununderstandable documents (wiki) #49

naveennamani opened this issue Jan 4, 2019 · 6 comments
Labels
enhancement This adds new functionallity to the product

Comments

@naveennamani
Copy link

There is a link to simple file in Home page in wiki, and there is no example in simple sample page, it has a link to home page again. There are four technical section which need to read by developers new to detours, but those sections give no information on how to get started with Detours.

Please improve the wiki, provide a useful example showing How to get started with Detours

@Trazzmonger
Copy link

Agree!!!

Every step in working with Detours seems to be a challenge. For example, it seems like only in the FAQs is the need to "nmake" the Detours library discussed ... and, even then, it doesn't specify which version of "nmake" should be used (e.g., my computer somehow has five versions of it in various directories), what pathing needs applied before running "nmake", how/where to find various required additional libraries (e.g., windows.h). All this stuff may seem obvious to the experienced ... but we newbies are left scratching our heads, guessing, and googling ... when this wiki should simply provide fully viable step-by-step instructions for downloading, building, and using Detours for the first time!

@0xeb
Copy link

0xeb commented May 23, 2019

Hey guys, you might find this helpful, let me know: https://github.com/0xeb/detours-cmake

@bgianfo bgianfo added the enhancement This adds new functionallity to the product label Aug 21, 2020
@bgianfo
Copy link
Contributor

bgianfo commented Aug 28, 2020

Hopefully PR #128 will make things slightly easier, I'll expand the documentation to talk about how to open a VS developer command prompt required to build.

@bgianfo
Copy link
Contributor

bgianfo commented Aug 28, 2020

Also #48 as well should improve things and make the project just like any other C++ build.

@bgianfo
Copy link
Contributor

bgianfo commented Aug 30, 2020

I fleshed out the FAQ a bit more with more details on setting up a build environment, the main thing being linking to the MSVC C++ command line tooling page, where they explain how to set up your developer command prompt. https://github.com/microsoft/Detours/wiki/FAQ#where-can-i-find-detourslib-and-detoursh

@yegor-pelykh
Copy link

I think that such poor documentation is due to the fact that Microsoft deliberately wanted it this way. This technology provides quite a lot of opportunities for developers, which also can not always be used for good purposes. Therefore, most likely, such a quest in order to increase the "entry threshold" for this technology. So that a person already understands at least roughly how it works, and also has skills and curiosity to work on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This adds new functionallity to the product
Projects
None yet
Development

No branches or pull requests

5 participants