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 README.md to include missing instructions for windows build #91

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,9 +181,14 @@ You can view the postman collection of the APIs [here](https://documenter.getpos
## Building Locally

### Pre Requsite

**Boost Libraries**
You must have boost libraries installed on your system. Incase you don't have you can either download the [sources](https://www.boost.org/users/download/) and build it, or install a precompiled binaries from [here](https://sourceforge.net/projects/boost/files/boost-binaries/).

**Vcpkg for Dependency Management**
Vcpkg is a C++ Library Manager for Windows, Linux, and MacOS. It simplifies the installation of software libraries.

You can find instructions for installing on Windows [here](https://github.com/Microsoft/vcpkg?tab=readme-ov-file#quick-start-windows)
**Note:** I recommend cloning the repo in `C:/Tools` contrary to the documentation

### Manual Compiling

Expand All @@ -197,6 +202,15 @@ git submodule update --init --recursive
run tinyphone/Debug/tinyphone.exe
```

### Fixing the LIBPATH Issue
Ensure the LIBPATH in Visual Studio project properties for tinyphone accurately points to the directories where the compiled libraries are located, including the correct path for libcurl and other dependencies.

**Note for Visual Studio 2019**
double check the `E:\lib\curl\builds` directory and verify that sub directory `libcurl-vc-x86-release-dll-ipv6-sspi-winssl` or `libcurl-vc**19**-x86-release-dll-ipv6-sspi-winssl` matches with what is on you LIBPATH.
1. You can update the LIBPATH so that they match (doc)[https://learn.microsoft.com/en-us/cpp/build/reference/libpath-additional-libpath?view=msvc-170]

2. or manually rename the folder to match what is in your LIBPATH

## Issues & Contribution

Found a issue and have a solution? Go ahead and create a pull request :) Incase you don't have a immediate solution but have an replicable issue please create an Issue with the details so that we can have a look at it.
Expand Down