Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 3.41 KB

BUILD.md

File metadata and controls

50 lines (31 loc) · 3.41 KB
Raw

Building ckb

Linux

You can build the project by running ./qmake-auto && make in a Terminal inside the ckb-master directory. The binaries will be placed in a new bin directory assuming they compile successfully. If you get a No suitable qmake found error, make sure Qt5 is installed and up to date. You may have to invoke qmake manually, then run make on its own. If you have Qt Creator installed, you can open ckb.pro (when asked to configure the project, make sure "Desktop" is checked) and use Build > Build Project "ckb" (Ctrl+B) to build the application instead.

Running as a service:

First copy the binary and the service files to their system directories:

  • Upstart (Ubuntu, prior to 15.04): sudo cp -R bin/* /usr/bin && sudo cp service/upstart/ckb-daemon.conf /etc/init
  • Systemd (Ubuntu 15.04 and later): sudo cp -R bin/* /usr/bin && sudo cp service/systemd/ckb-daemon.service /usr/lib/systemd/system
  • OpenRC: sudo cp -R bin/* /usr/bin && sudo cp service/openrc/ckb-daemon /etc/init.d/

To launch the driver and enable it at start-up:

  • Upstart: sudo service ckb-daemon start
  • Systemd: sudo systemctl start ckb-daemon && sudo systemctl enable ckb-daemon
  • OpenRC: sudo rc-service ckb-daemon start && sudo rc-update add ckb-daemon default

Open the bin directory and double-click on ckb to launch the user interface. If you want to run it at login, add ckb --background to your Startup Applications.

Running manually:

Open the bin directory in a Terminal and run sudo ./ckb-daemon to start the driver. To start the user interface, run ./ckb. Running the driver manually may be useful for testing/debugging purposes, but you must leave the terminal window open and you'll have to re-run it at every reboot, so installing it as a service is the best long-term solution.

OSX

Open ckb.pro in Qt Creator. You should be prompted to configure the project (make sure the "Desktop" configuration is selected and not iOS). Once it's finished loading, press Cmd+B or select Build > Build Project "ckb" from the menu bar. When it's done, you should see a newly-created ckb.app in the project directory. Exit Qt Creator.

Alternatively, open a Terminal in the ckb-master directory and run ./qmake-auto && make. It will detect Qt automatically if you installed it to one of the standard locations. You should see a newly created ckb.app if the build is successful.

Running as a service:

Copy ckb.app to your Applications folder. Copy the file service/launchd/com.ckb.daemon.plist to your computer's /Library/LaunchDaemons folder (you can get to it by pressing Cmd+Shift+G in Finder and typing the location). Then open a Terminal and run the following commands to launch the driver:

sudo chown root:wheel /Library/LaunchDaemons/com.ckb.daemon.plist
sudo chmod 0700 /Library/LaunchDaemons/com.ckb.daemon.plist
sudo launchctl load /Library/LaunchDaemons/com.ckb.daemon.plist

After you're done, open ckb.app to launch the user interface.

Running manually:

Open a Terminal in the ckb directory and run sudo ckb.app/Contents/Resources/ckb-daemon to start the driver. Open ckb.app to start the user interface. Note that you must leave the terminal window open and must re-launch the driver at every boot if you choose this; installing as a service is the better long term solution.