Skip to content

EmmaTheMartian/clockwork

Repository files navigation

clockwork

A language-agnostic build tool wrote to be efficient, easy, and extensible.

Installation

Linux

On Linux there is a Clockwork task to install itself which we can use here.

  1. v run . install
  2. Add ~/.local/bin to your $PATH if it is not already there.
  3. Yeah that's it.

Other OSes

I am not familiar with other operating systems and their CLIs, so I do not have installation tasks for them (yet). Here are the commands on Unix based systems to build and install Clockwork manually.

$ v -prod -o build/main .
$ mkdir -p ~/.local/bin/
$ cp ./build/main ~/.local/bin/
$ mkdir -p ~/.config/clockwork/
$ cp -r ./plugins ~/.config/clockwork/

# Or in one line:
$ v -prod -o build/main . && mkdir -p ~/.local/bin/ && cp ./build/main ~/.local/bin/ && mkdir -p ~/.config/clockwork/ && cp -r ./plugins ~/.config/clockwork/

The commands should be mostly the same on Windows

Uninstallation

Remove the ~/.local/bin/clockwork executable and ~/.config/clockwork

Basic Rundown

Make a file called build.maple in your project's root. Populate it with the following:

config:msg = 'Hello, World!'

task:hello = {
	run = 'echo "${msg}"'
}

Then run clockwork hello to see Hello, World! in the terminal.

For a proper example, see the example/ directory.

About

A language-agnostic build tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published