Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.81 KB

Contribute.md

File metadata and controls

37 lines (23 loc) · 1.81 KB
Raw

Contributing to Aerial

(If you want to help with translations, please check this page here.)

If you want to contribute code to Aerial, you are more than welcome!

Feel free to directly submit a PR for small changes or quick bug fixes, so we can have a look.

If you want to implement something more substantial, it might be a good idea to open an issue first to discuss what you want to do, so we can coordinate efforts and help you get around the existing codebase and it's various pitfalls.

Warning if you setup your repo prior to 1.7.2

Starting with version 1.7.2, we've removed the cocoapods dependency to Sparkle, and replaced it with a git submodule reference in /Extern). I strongly recomend you pull anew. If you still want to fix your existing repo I would suggest :

pod deintegrate
git pull
git submodule update --init --recursive

From your main repo folder.

How to compile Aerial

This is the easiest way to pull Aerial.

  • From terminal in a suitable location, run git clone --recurse-submodules https://github.com/JohnCoates/Aerial.git. This will bring Aerial and it's dependencies (Sparkle).
  • In the future, if you wish to update Sparkle, you can run git submodule update --init --recursive
  • Open the Aerial.xcodeproj in Xcode
  • Top left of the screen, pick the "AerialApp" scheme : Capture d’écran 2019-06-27 à 12 56 42
  • Build and run.

The AerialApp scheme compiles Aerial as an App, instead of a screensaver, so you can more easily test and debug your code in Xcode. Use the Aerial scheme to compile as a screensaver.

If you are running into an issue, feel free to open an issue so we can assist you.