diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f87ec30..74085c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Howdy! +# Contributing -Contributions are welcome! Please feel free to submit a Pull Request. +Pull request contributions are welcome! For major changes, please open an issue first to discuss what you would like to change. @@ -8,20 +8,31 @@ Please make sure to update tests and documentation as appropriate. ## Building from Source -Requirements: +### On Windows -- Node.js (supported version) -- Python 3 -- Platform-specific C++ build tools: - - Windows: Visual Studio Build Tools - - macOS: Xcode Command Line Tools - - Linux: GCC and development headers +When installing Node.js, on the "Tools for Native Modules" page, be sure to +["Automatically install the necessary +tools"](https://photostructure.com/server/photostructure-for-node/#step-2-install-nodejs). + +Also, in an Administrator PowerShell, run: + + choco install llvm + +### On macOS + +Install the Xcode Command Line Tools, and then + + brew install clang-format + +### On Ubuntu/Debian + + sudo apt-get install build-essential clang-format libglib2.0-dev libblkid-dev uuid-dev ## Before submitting your PR Run `npm run precommit`, which: -- re-formats your code, +- reformats your code - runs the linter - compiles the native and typescript code, and finally - runs all the tests @@ -33,4 +44,3 @@ into account both Windows and POSIX systems. - Windows on x64 - glibc Linux on x64 and arm64, with or without Gnome GIO support - MUSL Alpine Linux on x64 and arm64 - diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 862106a..0000000 --- a/INSTALL.md +++ /dev/null @@ -1,13 +0,0 @@ -## Prerequisite dev packages - -On Windows: - - choco install llvm - -On macOS: - - brew install clang-format - -On Ubuntu/Debian: - - sudo apt-get install build-essential clang-format libglib2.0-dev libblkid-dev uuid-dev