# CommandPost-App

CommandPost is made up of two seperate components:

* [CommandPost-App](https://github.com/CommandPost/CommandPost-App) contains the [Hammerspoon](http://www.hammerspoon.org) fork which makes up the main application.
* [CommandPost](https://github.com/CommandPost/CommandPost) contains all the [Lua](https://www.lua.org/about.html) scripts that drive the interface and feature set.

The goal of [CommandPost-App](https://github.com/CommandPost/CommandPost-App) is to always stay compatible with [Hammerspoon](http://www.hammerspoon.org), to allow us to always be able to bring across bug fixes and new features from the Hammerspoon repository to the ComamndPost-App fork.

We also don't touch the `Hammerspoon/setup.lua` or `extensions/_coresetup/init.lua` files within the [CommandPost-App](https://github.com/CommandPost/CommandPost-App) repository - this is all done in the [CommandPost](https://github.com/CommandPost/CommandPost) fork.

In most cases, you should never really need to make changes to [CommandPost-App](https://github.com/CommandPost/CommandPost-App), as all the user interfaces and features are built with Lua scripts.

However, if there is something missing from CommandPost-App that you want to add to the application (for example we added the "Drag & Drop to Dock" callbacks), ideally you would commit this to the main Hammerspoon repository first (so that the Hammerspoon community can also benefit from it), and then update CommandPost-App from [Hammerspoon/master](https://github.com/Hammerspoon/hammerspoon).

For more information on contributing to Hammerspoon, refer to their [Contribution Guide](https://github.com/Hammerspoon/hammerspoon/blob/master/CONTRIBUTING.md).

There's also a fantastic Hammerspoon Module Walkthrough [here](https://github.com/asmagill/HS_ModuleWalkthrough), which includes examples of how to make Objective-C extensions.

If you have any questions about this, feel free to [submit an issue](https://github.com/CommandPost/CommandPost-App/issues).

---

<script src="https://giscus.app/client.js"
        data-repo="CommandPost/CommandPost"
        data-repo-id="MDEwOlJlcG9zaXRvcnk3NDY0NTk2NQ=="
        data-category="Website Discussion"
        data-category-id="DIC_kwDOBHMBzc4CXFFA"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="dark"
        data-lang="en"
        crossorigin="anonymous"
        async>
</script>