we need a Makefile

.. and update README

Author: weedz

Makefile

@@ -0,0 +1,13 @@
+all: check git-good
+
+check:
+	pnpm run lint
+
+clean:
+	rm -rf dist
+
+nodegit:
+	pnpm run build:native
+
+git-good: nodegit
+	pnpm run build

README.md

@@ -1,15 +1,36 @@
 # git-good
+
 Just a simple git client using electron and nodegit, focus on lightweight and performance
 
+Build for linux:
+
+```bash
+pnpm install
+
+# make sure nodegit dependencies are installed and build nodegit against node
+# pnpm does not clone with submodules so need to re-clone the nodegit repo
+rm -rf node_modules/nodegit && \
+mkdir node_modules/nodegit && \
+pushd node_modules/nodegit && { \
+  git clone --recurse-submodules https://github.com/weedz/nodegit . && \
+  # `--ignore-scripts` to prevent something (node-gyp ?) from automatically building
+  pnpm install --ignore-scripts && \
+  JOBS=max pnpm run rebuild \
+}; popd;
+
+# build nodegit for electron, and "compile" typescript files
+make
+pnpm start
+```
+
 ## Build from source
 
 Follow instructions from <https://github.com/nodegit/nodegit>.
 
 ### Linux
 
-```
-JOBS=max npm_config_openssl_bin_url=skip pnpm run electron-rebuild
-pnpm run dist
+```bash
+make
 ```
 
 ### Arch Linux
@@ -19,25 +40,30 @@ PKGBUILD is available from <https://github.com/weedz/git-good-pkgbuild>.
 ### Ubuntu/debian
 
 To successfully build/link nodegit on linux you will need the following packages:
-```
+
+```plain
 build-essential
 libssh-dev
 libkrb5-dev
 ```
 
 ### Windows
 
-Install <https://github.com/Microsoft/vcpkg> (C and C++ package manager for windows), needed for openssl dependency. Then install the `openssl` package with:
+Install <https://github.com/Microsoft/vcpkg> (C and C++ package manager for windows),
+needed for openssl dependency. Then install the `openssl` package with:
+
 ```bash
 > vcpgk install openssl
 ```
 
 #### vcpkg
 
-Follow instuctions here, <https://github.com/Microsoft/vcpkg>.
+Follow instructions here, <https://github.com/Microsoft/vcpkg>.
 
 1. Clone to something like `C:\dev\vcpkg`. And run the "bootstrap" script.
-2. On windows we need `openssl@1.1.1`. In order to install this with `vcpkg` we need a `vcpkg.json` file. Create the following file in `C:\dev`:
+2. On windows we need `openssl@1.1.1`. In order to install this with `vcpkg`
+we need a `vcpkg.json` file. Create the following file in `C:\dev`:
+
    ```json
    {
         "dependencies": [
@@ -52,26 +78,26 @@ Follow instuctions here, <https://github.com/Microsoft/vcpkg>.
         ]
     }
     ```
+
     (What is `builtin-baseline`, <https://learn.microsoft.com/en-us/vcpkg/users/examples/versioning.getting-started#builtin-baseline>)
     And run `.\vcpkg\vcpkg.exe install` in `C:\dev`.
-3. Make sure to use correct Visual Studio version, <https://github.com/nodejs/node-gyp#on-windows>. Does not build with msvs2022. Need msvs2019: `npm config set msvs_version 2019`
-4. Seems like the "postinstall" script for `nodegit` will fail on windows. But the `electron-rebuild` script will succeed.
+3. Make sure to use correct Visual Studio version, <https://github.com/nodejs/node-gyp#on-windows>.
+Does not build with msvs2022. Need msvs2019: `npm config set msvs_version 2019`
+4. Seems like the "postinstall" script for `nodegit` will fail on windows.
+But the `electron-rebuild` script will succeed.
 
 ## Start
 
 Install node modules:
+
 ```bash
-$ pnpm install
+pnpm install
 ```
 
 Then run
-```bash
-$ pnpm run build
-```
-to bundle javascript-files and move assets to the `dist/` directory.
 
-Now run
 ```bash
-$ pnpm run dist
+pnpm run build
 ```
-to compile all the native dependencies etc. You can run this with `CC="ccache gcc" JOBS=max pnpm run dist` (omit `CC="ccache gcc"` if you don't have `ccache` installed) to speed up compile time.
+
+to bundle javascript-files and move assets to the `dist/` directory.

package.json

@@ -22,16 +22,19 @@
   ],
   "license": "GPL-3.0-or-later",
   "devDependencies": {
-    "@types/node": "^22.19.2",
+    "@types/node": "^22.19.3",
     "@types/nodegit": "^0.28.9",
     "@weedzcokie/store": "^2.0.3",
     "electron": "38.7.2",
-    "esbuild": "^0.27.1",
-    "oxlint": "^1.32.0",
-    "oxlint-tsgolint": "^0.8.5",
+    "esbuild": "^0.27.2",
+    "oxlint": "^1.35.0",
+    "oxlint-tsgolint": "^0.10.0",
     "preact": "^10.28.0",
     "typescript": "^5.9.3"
   },
+  "dependencies": {
+    "nodegit": "github:weedz/nodegit#master"
+  },
   "resolutions": {
     "@electron/get": "^4",
     "node-abi": "^4"
@@ -72,8 +75,5 @@
     "node": ">=22",
     "pnpm": ">=10"
   },
-  "dependencies": {
-    "nodegit": "github:weedz/nodegit#master"
-  },
-  "packageManager": "pnpm@10.25.0+sha512.5e82639027af37cf832061bcc6d639c219634488e0f2baebe785028a793de7b525ffcd3f7ff574f5e9860654e098fe852ba8ac5dd5cefe1767d23a020a92f501"
+  "packageManager": "pnpm@10.26.1+sha512.664074abc367d2c9324fdc18037097ce0a8f126034160f709928e9e9f95d98714347044e5c3164d65bd5da6c59c6be362b107546292a8eecb7999196e5ce58fa"
 }