Skip to content
This repository was archived by the owner on Feb 27, 2019. It is now read-only.

Latest commit

 

History

History
36 lines (29 loc) · 3.21 KB

BUILDAK.md

File metadata and controls

36 lines (29 loc) · 3.21 KB

Building Apps with AliceKit

This document will go over how to install the proper packages required to build apps with AliceKit enabled.

What's AliceKit?

AliceKit icon

AliceKit is a collecton of libraries and tools used to create wonderful apps and extensions using Swift and Qt. It includes the following (but not limited to):

  • Qlift - the binding used to link Swift and Qt together
  • CMake - the building and compling tool for C-based projects
  • Clang - Yet another compiler that works with Swift
  • Swift - the programming language and debugging tools for writing AliceKit apps
  • (coming soon) Cambria - an SDK for Artemis's desktop shell, Desiree

Setting Up AliceKit

Automatic

To simplify the installation of AliceKit and all of its components, users and developers can install the Swift Machine IDE to easily create apps and download the required packages.

Sadly, our own ink machine for this hasn't been filled up, but we'll get there soon. Bendy, can we borrow some of your ink?

Manual

Note: The following instructions have been written for Ubuntu, but users of other Linux distros can follow the same principles.

  1. Start by having a clean install of Ubuntu. This will help ensure that your apps will work correctly and that nothing else is broken in the process.
  2. Install the required dependencies by running the command sudo apt install clang cmake git qtbase5-dev. This will fetch and install Clang, CMake, Git, and the Qt 5 developer libraries.
  3. Download the Swift package for your respective version of Ubuntu. At the time of writing, the current version is 3.1.1. Extract the contents of the Swift package and merge the usr folder with your system's usr folder (you'll need root permissions to do this). This will install Swift system-wide.
  4. To confirm that you installed Swift correctly, run swift --version.
  5. The source code for Qlift will need to be pulled into the system at /usr/local/. To accomplish this, do the following:
  6. Give staff access by running sudo chown -R root:staff /usr/local/.
  7. Add yourself to the staff group by running sudo usermod -a -G staff <userName>, where is your username. Reboot the system for changes to take effect.
  8. Finally, run sudo chmod -R g+w /usr/local/ to give staff access to write files. You may need to reboot here as well.
  9. To test, go into the directory and run touch goatfile. If done properly, you should be able to create a goat file without needing root permissions.
  10. Download Qlift by running the command git clone https://www.github.com/longhanks/qlift-c-api in the usr/local/src/ folder.
  11. Install Qlift by running cmake -DCMAKE_INSTALL_PREFIX=/usr, followed by make; sudo make install.
  12. Build your app in your respective location, pulling the AliceKit template from GitHub.
  13. To build and run your app, run swift build and then ./.build/debug/<nameofapp>, where is the name of your application.