Skip to content

sheik/create

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Create

Create is a language agnostic build tool that allows you to define steps and dependencies.

Using Create in Your Project

In order to use create, first go into your project directory (with go module set up) and execute the following:

go install github.com/sheik/create/cmd/create@latest
create update 

Next, you need to make a "createfile". In order to do this, you need to create a command (package main) called "createfile" under your "cmd" directory in your project (for details on the "cmd" directory, see Standard Go Project Layout. For example:

.
├── cmd
│   ├── createfile
│   │   └── createfile.go
│   └── myproject
│       └── main.go
├── go.mod
├── go.sum
├── internal
│   └── utils
│       └── utils.go
└── pkg
    └── shell
	└── shell.go

Once you have a createfile in the ./cmd/ directory, and you have "create" installed, simply do:

create            # this will run your creatfile
create help       # diplays createfile help
create <target>   # execute target

If you want a Makefile to help make lives easier, create a Makefile that looks like the following:

.PHONY: default install

install:
    @go install github.com/sheik/create/cmd/create@latest

default: install
    @$(MAKE) -s package

.:
    @create $@

This should pass through any commands you feed to "make" into "create". It will also ensure you have the latest copy of "create".

Example Createfile

Click to see a createfile example

Building Your Project

Once you have installed "create" into your project and created a createfile, building your is as simple as running:

user@host:/home/user/myProject$ create <target>

You can run it without specifying a target, in which case it will run whichever target has "Default" set to "true".

License

This project is licensed under the terms of the MIT license. See LICENSE.md for details.