Skip to content

Conversation

@stephenegriffin
Copy link
Member

This pull request introduces significant improvements to the build configuration, developer documentation, and project setup for the MAPI Stub Library. The changes make it easier for developers to build, link, and integrate the library into their projects, regardless of platform or build system. The documentation has been expanded to include detailed guides and FAQs, and the build scripts have been updated to support multiple architectures and static linking.

Fixes #26

Documentation improvements:

  • Added docs/Building.md, providing step-by-step instructions for building the library with Visual Studio and Node.js/node-gyp, including output details.
  • Added docs/FAQ.md with answers to common questions about usage, linking, building, and troubleshooting the library.
  • Added docs/Linking.md to guide users on linking their projects to MAPIStubLibrary.lib as a drop-in replacement for mapi32.lib.
  • Added docs/DirectlyIncluding.md explaining how to include the source files directly in a project and use optional stub utility functions.

Minor fixes:

  • Corrected a typo in the comment in library/stubutils.h.
  • Updated the FAQ link in README.md to point to the new local documentation.

Build system and configuration enhancements:

  • Updated binding.gyp to define the target as a static library (MAPIStubLibrary), added architecture-specific output directories, MSVC compiler settings, and preprocessor defines for better Windows compatibility.
  • Added package.json with scripts for building and cleaning the library using node-gyp, supporting x64, x86, and ARM64 architectures.

@github-actions
Copy link

github-actions bot commented Oct 2, 2025

Test Results

0 tests  ±0   0 ✅ ±0   0s ⏱️ ±0s
0 suites ±0   0 💤 ±0 
0 files   ±0   0 ❌ ±0 

Results for commit a031d7e. ± Comparison against base commit edb8eb5.

@stephenegriffin stephenegriffin merged commit de173c6 into main Oct 2, 2025
17 checks passed
@stephenegriffin stephenegriffin deleted the u/sgriffin/docs branch October 2, 2025 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Dead FAQ link

3 participants