Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 1.31 KB

Contribute.md

File metadata and controls

22 lines (14 loc) · 1.31 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.

How to compile Aerial

  • Grab the repository
  • In terminal in the root of the repository, run pod update to bring Sparkle
  • Open the Aerial.xcworkspace in Xcode (you need at least Xcode 10.2, or Xcode 11 beta). You must open the xcworkspace, not the xcodeproj.
  • 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.