Note

The below is a template for a good looking README provided by Archetype. It will be filled in with more information as the Boulder approaches its initial release.

---

Boulder

Get stuff done, when it needs to be done.

Report a problem!

Installation

Dependencies

These dependencies must be present before building:

• meson
• valac
• debhelper
• libgranite-dev
• libgtk-3-dev

Use the App script to simplify installation by running ./app install-deps

Building

git clone https://github.com/ChristopherNugent/Boulder.git com.github.christophernugent.boulder && cd com.github.christophernugent.boulder
./app install-deps && ./app install

Deconstruct

./app uninstall

Development & Testing

Boulder includes a script to simplify the development process. This script can be accessed in the main project directory through ./app.

Usage:
  ./app [OPTION]

Options:
  clean             Removes build directories (can require sudo)
  generate-i18n     Generates .pot and .po files for i18n (multi-language support)
  install           Builds and installs application to the system (requires sudo)
  install-deps      Installs missing build dependencies
  run               Builds and runs the application
  test              Builds and runs testing for the application
  test-run          Builds application, runs testing and if successful application is started
  uninstall         Removes the application from the system (requires sudo)

Contributing

To help, access the links below:

• Guide on Code Style

• Proposing Design Changes

• Reporting Bugs

• Translate

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.