Skip to content

c4s4/neon

Repository files navigation

NeON

Build Status Code Quality Codecov License

NeON is the build tool the way I dreamed it.

Installation

Unix users (Linux, BSDs and MacOSX)

Unix users may download and install latest NeON release with command:

sh -c "$(curl https://sweetohm.net/dist/neon/install)"

If curl is not installed on you system, you might run:

sh -c "$(wget -O - https://sweetohm.net/dist/neon/install)"

Note: Some directories are protected, even as root, on MacOSX (since El Capitan release), thus you can't install NeON in /usr/bin for instance.

Go developers

Go developers can install latest release with following command:

go get -u github.com/c4s4/neon

Note that NeON built this way won't display version number with neon -version command and that you must build with Go 1.10 or newer.

Binary package

Otherwise, you can download latest binary archive at https://github.com/c4s4/neon/releases. Unzip the archive, put the binary of your platform somewhere in your PATH and rename it neon.

Bash completion

Unix users can add Bash completion putting file bash/neon of the binary archive in /etc/bash_completion.d/ directory and adding following line in their ~/.bashrc file:

. /etc/bash_completion.d/neon

This will enable following completions:

  • Typing neon and hitting TAB will complete on build targets.
  • Typing neon -task and hitting TAB will complete on tasks.
  • Typing neon -builtin and hitting TAB will complete on builtins.

Documentation

There are four sources of documentation:

Build

This project implements Go 1.11 modules, thus you must use Go version 1.11 of above to build NeON. To build the project without NeON already installed, follow these steps:

  • Clone the project with git clone git@github.com:c4s4/neon.git.
  • Go into the project directory, that must be outside your GOPATH.
  • Build the binary with command go install -ldflags -X github.com/c4s4/neon/build.NeonVersion==VERSION

This will produce the neon binary for your OS and architecture in the bin directory of your GOPATH.

If neon is already installed, simply type neon install, this will generate neon binary in bin directory of your GOPATH.

Contributors

Active contributors are:

Please feel free to contribute and send your patches or pull requests, they will be reviewed and integrated as soon as possible.

Enjoy!