Skip to content

Commit

Permalink
merge INSTALL into CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
mceachen committed Dec 18, 2024
1 parent 41e7fdf commit 4c95dc9
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 24 deletions.
32 changes: 21 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,38 @@
# 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.

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
Expand All @@ -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

13 changes: 0 additions & 13 deletions INSTALL.md

This file was deleted.

0 comments on commit 4c95dc9

Please sign in to comment.