disable actions and add instrucitons (#27)

4 files changed, 97 insertions, 22 deletions

diff --git a/.github/workflows/doxygen-and-linux-test.yml b/.github/workflows/doxygen-and-linux-test.yml
index d88f0bb73..6becfbeeb 100644
--- a/.github/workflows/doxygen-and-linux-test.yml
+++ b/.github/workflows/doxygen-and-linux-test.yml
@@ -3,42 +3,23 @@ name: Doxygen GitHub Pages Deploy Action
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   deploy:
+    if: 0
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4.1.1
         with:
           submodules: "true"
-      - name: Get Complementary file
-        uses: actions/checkout@v4.1.1
-        with:
-          path: complementary_file
-          repository: UnspaghettifyKart/action-build-private-file
-          ssh-key: ${{ secrets.LINUX_DEPLOY_SSH_PRIVATE_KEY }}
-      - name: Install dependencies
-        run: |
-          sudo apt install build-essential cmake pkg-config git binutils-mips-linux-gnu python3 zlib1g-dev libaudiofile-dev libcapstone-dev
-      - name: Build
-        run: |
-          cp -r complementary_file/* .
-          echo "${{ secrets.AES_KEY }}" | openssl enc -d -aes-256-cbc -pass stdin -pbkdf2 -in baserom.us.z64.aes -out baserom.us.z64
-          make assets
-          make -j
       - name: Install Doxygen
         run: |
           sudo apt-get install graphviz doxygen
-          wget https://www.doxygen.nl/files/doxygen-1.10.0.linux.bin.tar.gz
+          wget https://www.doxygen.nl/files/doxygen-1.11.0.linux.bin.tar.gz
           tar -xzf doxygen-*.linux.bin.tar.gz
       
-      - name: make badge
-        run: |
-          pip install pybadges
-          python3 progress.py badge
-      
       - name: Generate Doxygen documentation
         run: |
           ./doxygen-*/bin/doxygen Doxyfile
diff --git a/.github/workflows/linux-compile.yml b/.github/workflows/linux-compile.yml
index 7ef63168d..c5893fe5d 100644
--- a/.github/workflows/linux-compile.yml
+++ b/.github/workflows/linux-compile.yml
@@ -8,6 +8,7 @@ on:
 
 jobs:
   build:
+    if: 0
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4.1.1
diff --git a/.github/workflows/windows-compile.yml b/.github/workflows/windows-compile.yml
index 2b2b61015..28f3c4890 100644
--- a/.github/workflows/windows-compile.yml
+++ b/.github/workflows/windows-compile.yml
@@ -8,6 +8,7 @@ on:
 
 jobs:
   build:
+    if: 0
     runs-on: windows-2022
     steps:
       - uses: actions/checkout@v4.1.1
diff --git a/docs/PORT-BUILDING.md b/docs/PORT-BUILDING.md
new file mode 100644
index 000000000..1b278cf82
--- /dev/null
+++ b/docs/PORT-BUILDING.md
@@ -0,0 +1,92 @@
+If you have some problem to get it setup you can refer to [https://github.com/HarbourMasters/Shipwright/blob/develop/docs/BUILDING.md](https://github.com/HarbourMasters/Shipwright/blob/develop/docs/BUILDING.md)
+
+# Contribute
+
+## Github
+1) Fork
+2) Create a new branch
+3) `git clone --branch <branch_name> <fork_url>`
+
+4) Place baserom.us.z64 in root.
+5) `git submodule update --init`
+6) copy from mk64 assets/course in assets 
+
+# Windows
+
+## Setup
+```bat
+& 'C:\Program Files\CMake\bin\cmake' -S . -B "build/x64" -G "Visual Studio 17 2022" -T v142 -A x64
+```
+
+## Extract Assets
+```bat
+& 'C:\Program Files\CMake\bin\cmake' --build "build/x64" --target ExtractAssets
+```
+
+## Compile
+```bat
+& 'C:\Program Files\CMake\bin\cmake.exe' --build .\build\x64
+```
+
+## Clean
+```bat
+& 'C:\Program Files\CMake\bin\cmake.exe' --build .\build\x64 --target clean
+```
+
+# Linux
+## Install dependencies
+### Debian/Ubuntu
+(not tried)
+```sh
+# using gcc
+apt-get install gcc g++ git cmake ninja-build lsb-release libsdl2-dev libpng-dev libsdl2-net-dev libzip-dev zipcmp zipmerge ziptool nlohmann-json3-dev libtinyxml2-dev libspdlog-dev libboost-dev libopengl-dev
+
+# or using clang
+apt-get install clang git cmake ninja-build lsb-release libsdl2-dev libpng-dev libsdl2-net-dev libzip-dev zipcmp zipmerge ziptool nlohmann-json3-dev libtinyxml2-dev libspdlog-dev libboost-dev libopengl-dev
+```
+### Arch
+(not tried)
+```sh
+# using gcc
+pacman -S gcc git cmake ninja lsb-release sdl2 libpng libzip nlohmann-json tinyxml2 spdlog sdl2_net boost
+
+# or using clang
+pacman -S clang git cmake ninja lsb-release sdl2 libpng libzip nlohmann-json tinyxml2 spdlog sdl2_net boost
+```
+### Fedora
+```sh
+# using gcc
+dnf install gcc gcc-c++ git cmake ninja-build lsb_release SDL2-devel libpng-devel libzip-devel libzip-tools json-devel tinyxml2-devel spdlog-devel boost-devel SDL2_net-devel
+
+# or using clang
+dnf install clang git cmake ninja-build lsb_release SDL2-devel libpng-devel libzip-devel libzip-tools json-devel tinyxml2-devel spdlog-devel boost-devel SDL2_net-devel
+```
+### openSUSE
+(not tried)
+```sh
+# using gcc
+zypper in gcc gcc-c++ git cmake ninja SDL2-devel libpng16-devel libzip-devel libzip-tools nlohmann_json-devel tinyxml2-devel spdlog-devel
+
+# or using clang
+zypper in clang libstdc++-devel git cmake ninja SDL2-devel libpng16-devel libzip-devel libzip-tools nlohmann_json-devel tinyxml2-devel spdlog-devel
+```
+
+## Setup
+```bash
+cmake -H. -Bbuild-cmake -GNinja
+```
+
+## Extract Assets
+```bash
+cmake --build build-cmake --target ExtractAssets
+```
+
+## Compile
+```bash
+cmake --build build-cmake
+```
+
+## Clean
+```bash
+cmake --build build-cmake --target clean
+```
\ No newline at end of file