🧀 Cheddar, the language that works for you
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
benchmark
bin
bindings
local_modules
misc
src
test
.babelrc
.gitignore
.gitmodules
.istanbul.yml
.npmignore
.travis.yml
CHANGELOG
LICENSE
Makefile
README.md
changelog.cheddar
changelog.py
circle.yml
codecov.yml
package.json

README.md

Cheddar

Travis Status Coverage Status Codecov Join the chat at https://gitter.im/cheddar-lang/Cheddar npm Dependency Status Ready Items

WebsiteDownloadDocumentation

The language that works for you

Developing

Development for cheddar is described in detail on the docs. But first, to clone the cheddar repository, use the following:

$ git clone --recursive https://github.com/cheddar-lang/Cheddar.git

Additionally, when syncing your branch with the latest update to develop, use the following command to avoid merge commmits:

$ git rebase develop -X theirs

Once your changes are ready to merge, submit a PR to the develop branch where it'll be reviewed and then merged if applicable

Manual Installation

Manual installation is simple. The only dependencies you must have are git and nodejs + npm. Additionally you should have make (preferably GNU), but this comes by default on almost every *nix system.

  • First, refer to the "Development" section for cloning the Cheddar repository.

  • The next step is to install the dependencies with npm. An automatic build should trigger if dependencies are installed succesfully. Once this command is finished you should see a dist/ directory created. If you don't, look for any errors in the installation.

$ npm install
  • Manually building / testing

You can use make to run the build, test, and install tasks:

$ make         # Production Build
$ make build   # Development Build
$ make test    # Run tests
  • Installing.

If you want to install the Cheddar CLI, you have some options. If you are doing a production installation, use make install. For all other cases use ./bin/install; with this you can pass a --method argument to specify whether you'd like to install for yourself (--method=alias) or for everyone on your computer (--method=path, the default) which may require elevated privileges. With --method=alias, provide the location of your bashrc file or equivalent with the --rcloc flag (usually for *nix systems this is ~/.bashrc, and for Mac this is ~/.bash_profile). You may specify the installation path with --method=path, Cheddar installs the binary in <path>/bin/cheddar and <path>/share/cheddar; this defaults to /usr/local.