nbarrios / arcdps-uploader

Arcdps Combat Log Uploader Extension
Other
15 stars 7 forks source link

[Documentation request] Add instructions for installing dependencies and building #35

Open SniderThanYou opened 1 year ago

SniderThanYou commented 1 year ago

Motivation: make it easier for the community to contribute PRs by reducing the barrier to entry.

I was able to sort out a set of instructions myself, but you might know some shortcuts, and it's also possible I've left something out, since I tried a bunch of different things last night.

Prerequisites

  1. Visual Studio (I'm using 2022 Community Edition)
  2. Git for Windows
  3. CMake for Windows

vcpkg

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg.git
.\bootstrap-vcpkg.bat
cd ..

Build

git clone https://github.com/nbarrios/arcdps-uploader.git
cd arcdps-uploader
git submodule update --init --recursive
..\vcpkg\vcpkg.exe install
cmake -B build -S . -DCMAKE_TOOLCHAIN_FILE=../vcpkg/scripts/buildsystems/vcpkg.cmake -A x64 -DVCPKG_TARGET_TRIPLET=x64-windows-static -G "Visual Studio 17 2022"
covertPZ commented 1 year ago

I also had some issues trying to get started with the project and some more documentation would be especially helpful in order to contribute.

punsii2 commented 1 year ago

https://github.com/cheahjs created a configuration for building with github actions some time ago.

I cleaned his commits up a little and also tried fixing the automatic github release action. As i recall the build produced functional artifacts but the automatic github release still had problems, so i did not submit it back to the main repo. https://github.com/punsii2/arcdps-uploader/commits/github-actions

Just wanted to leave this here in case someone wants to have another look at it.

nbarrios commented 1 year ago

I switched over to using GitHub actions to build releases a while back but I will add some local build instructions to the readme.