Skip to content

Commit a9a9094

Browse files
committed
we need a Makefile
1 parent 81ec38d commit a9a9094

2 files changed

Lines changed: 26 additions & 12 deletions

File tree

Makefile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
all: check git-good
2+
3+
check:
4+
pnpm run lint
5+
6+
clean:
7+
rm -rf dist
8+
9+
nodegit:
10+
pnpm run build:native
11+
12+
git-good: nodegit
13+
pnpm run build

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# git-good
2+
23
Just a simple git client using electron and nodegit, focus on lightweight and performance
34

45
## Build from source
@@ -7,9 +8,8 @@ Follow instructions from <https://github.com/nodegit/nodegit>.
78

89
### Linux
910

10-
```
11-
JOBS=max npm_config_openssl_bin_url=skip pnpm run electron-rebuild
12-
pnpm run dist
11+
```bash
12+
make
1313
```
1414

1515
### Arch Linux
@@ -19,7 +19,8 @@ PKGBUILD is available from <https://github.com/weedz/git-good-pkgbuild>.
1919
### Ubuntu/debian
2020

2121
To successfully build/link nodegit on linux you will need the following packages:
22-
```
22+
23+
```plain
2324
build-essential
2425
libssh-dev
2526
libkrb5-dev
@@ -28,6 +29,7 @@ libkrb5-dev
2829
### Windows
2930

3031
Install <https://github.com/Microsoft/vcpkg> (C and C++ package manager for windows), needed for openssl dependency. Then install the `openssl` package with:
32+
3133
```bash
3234
> vcpgk install openssl
3335
```
@@ -38,6 +40,7 @@ Follow instuctions here, <https://github.com/Microsoft/vcpkg>.
3840

3941
1. Clone to something like `C:\dev\vcpkg`. And run the "bootstrap" script.
4042
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`:
43+
4144
```json
4245
{
4346
"dependencies": [
@@ -52,6 +55,7 @@ Follow instuctions here, <https://github.com/Microsoft/vcpkg>.
5255
]
5356
}
5457
```
58+
5559
(What is `builtin-baseline`, <https://learn.microsoft.com/en-us/vcpkg/users/examples/versioning.getting-started#builtin-baseline>)
5660
And run `.\vcpkg\vcpkg.exe install` in `C:\dev`.
5761
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`
@@ -60,18 +64,15 @@ Follow instuctions here, <https://github.com/Microsoft/vcpkg>.
6064
## Start
6165

6266
Install node modules:
67+
6368
```bash
64-
$ pnpm install
69+
pnpm install
6570
```
6671

6772
Then run
68-
```bash
69-
$ pnpm run build
70-
```
71-
to bundle javascript-files and move assets to the `dist/` directory.
7273

73-
Now run
7474
```bash
75-
$ pnpm run dist
75+
pnpm run build
7676
```
77-
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.
77+
78+
to bundle javascript-files and move assets to the `dist/` directory.

0 commit comments

Comments
 (0)