Skip to content

Commit

Permalink
Remove-nw (#38)
Browse files Browse the repository at this point in the history
* remove nw

* fix readme [skip ci]

---------

Co-authored-by: Filipe Freire <livrofubia@gmail.com>
  • Loading branch information
jackkav and filfreire authored May 21, 2024
1 parent a9292dc commit bb7984f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 33 deletions.
20 changes: 0 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,29 +166,9 @@ git push

#### Build Matrix

We are using three CI providers:

- CircleCI
- GitHub Actions
- AppVeyor

Each CI provider is responsible for some builds:

CircleCI:

- Node.js (Alpine)
- Electron (linux)
- NW.js (linux)

GitHub Actions:

- Node.js (Linux, macOS)
- Electron (macOS)
- NW.js (macOS)

AppVeyor:

- Node.js (Win64, Win32)
- Electron (Win64, Win32)

GitHub Actions are also used to lint PRs, for that a build runs on Linux.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,12 @@
- [Detailed Installation](#detailed-installation)
- [Important Notes on Prebuilt Binaries / Direct Installation](#important-notes-on-prebuilt-binaries--direct-installation)
- [Missing Packages](#missing-packages)
- [Electron / NW.js](#electron--nwjs)
- [NW.js (aka node-webkit)](#nwjs-aka-node-webkit)
- [Electron](#electron)
- [Electron (aka atom-shell)](#electron-aka-atom-shell)
- [Electron >= 11 / NW.js >= 0.50](#electron--11--nwjs--050)
- [Electron \>= 11](#electron--11)
- [Building on Linux](#building-on-linux)
- [Building on macOS](#building-on-macos)
- [Xcode >= 10 | macOS >= Catalina](#xcode--10--macos--catalina)
- [Xcode \>= 10 | macOS \>= Catalina](#xcode--10--macos--catalina)
- [Building on Windows](#building-on-windows)
- [Getting Help](#getting-help)
- [Contributing](#contributing)
Expand Down Expand Up @@ -273,15 +272,14 @@ available for:

- Node.js: Latest two versions on active LTS (see <https://github.com/nodejs/Release>)
- Electron: Latest 3 major versions
- NW.js (node-webkit): Latest 3 major (minor for nw.js case) versions

And on the following platforms:

- Linux 64 bits
- Mac OS X 64 bits
- Windows 32 and 64 bits

Installing with `npm install node-libcurl` should download a prebuilt binary and no compilation will be needed. However if you are trying to install on `nw.js` or `electron` additional steps will be required, check their corresponding section below.
Installing with `npm install node-libcurl` should download a prebuilt binary and no compilation will be needed. However if you are trying to install on `electron` additional steps will be required, check their corresponding section below.

The prebuilt binary is statically built with the following library versions, features and protocols (library versions may change between Node.js versions):

Expand All @@ -294,7 +292,7 @@ Features: AsynchDNS, IDN, IPv6, Largefile, NTLM, NTLM_WB, SSL, libz, brotli, TLS
If there is no prebuilt binary available that matches your system, or if the installation fails, then you will need an environment capable of compiling Node.js addons, which means:

- [python 2.7](https://www.python.org/download/releases/2.7) installed
- updated C++ compiler able to compile C++11, or if building Electron >= 11 / NW.js >= 0.50, C++17 (see the [Electron >= 11 / NW.js >= 0.50](#electron--11--nwjs--050) section below).
- updated C++ compiler able to compile C++11, or if building Electron >= 11, C++17 (see the [Electron >= 11](#electron--11) section below).

If you don't want to use the prebuilt binary even if it works on your system, you can pass a flag when installing:

Expand Down Expand Up @@ -340,7 +338,7 @@ The scripts to build Kerberos exists on the `./scripts/ci` folder, but it was re
- If built with Heimdal, the addon becomes too big
- If built with MIT Kerberos, the addon would be bound to their licensing terms.

### Electron / NW.js
### Electron

If building for a `Electron` you need to pass additional parameters to the install command.

Expand All @@ -365,9 +363,9 @@ target_arch = x64
dist_url = https://atom.io/download/atom-shell
```

#### Electron >= 11 / NW.js >= 0.50
#### Electron >= 11

If you are building for Electron >= 11 or NW.js >= 0.50 you need to set the build process to use the C++17 std, you can do that by passing the variable `node_libcurl_cpp_std=c++17`.
If you are building for Electron >= 11 you need to set the build process to use the C++17 std, you can do that by passing the variable `node_libcurl_cpp_std=c++17`.

> If using `npm`:
Expand Down
3 changes: 0 additions & 3 deletions scripts/ci/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,6 @@ curl-config --cflags
DISPLAY=${DISPLAY:-}
PUBLISH_BINARY=${PUBLISH_BINARY:-}
ELECTRON_VERSION=${ELECTRON_VERSION:-}
# NWJS_VERSION=${NWJS_VERSION:-}
RUN_TESTS=${RUN_TESTS:-"true"}

if [ -z "$PUBLISH_BINARY" ]; then
Expand Down Expand Up @@ -364,8 +363,6 @@ fi
if [ "$RUN_TESTS" == "true" ]; then
if [ -n "$ELECTRON_VERSION" ]; then
[ $run_tests_electron == "true" ] && npm run test:electron || echo "Tests for this version of electron were disabled"
elif [ -n "$NWJS_VERSION" ]; then
echo "No tests available for node-webkit (nw.js)"
else
npm run ts-node -e "console.log(require('./lib').Curl.getVersionInfoString())" || true
npm run test
Expand Down

0 comments on commit bb7984f

Please sign in to comment.