Giter VIP home page Giter VIP logo

carton's Introduction

Carton

Carton

Carton for Emacs is what Bundler is to Ruby. It aims to make ELPA dependency management in Emacs painless (as painless as it can be). This includes both your local Emacs installation and Emacs package development.

Installation

To automatically install Carton, run this command:

curl -fsSkL https://raw.github.com/rejeep/carton/master/go | sh

You can also clone the repository.

$ git clone https://github.com/rejeep/carton.git

Don't forget to add Carton's bin to your PATH.

$ export PATH="/path/to/code/carton/bin:$PATH"

Usage

Create a file called Carton in your project root and specify dependencies. To install all dependencies, run:

$ carton [install]

This will create a directory calledelpa, containing all dependencies.

Local Emacs installation

Add this to your .emacs file.

(require 'package)
(package-initialize)

That's it!

Package development

To create a -pkg.el file, run:

$ carton package

To run some Emacs Lisp code with ELPA load paths all set up for you, use:

$ carton exec [COMMAND]

Example:

$ carton exec make test

DSL

source

Add an ELPA mirror.

(source NAME URL)

Example:

(source "melpa" "http://melpa.milkbox.net/packages/")

package

Define this package (used only for package development).

(package NAME VERSION DESCRIPTION)

Example:

(package "ecukes" "0.2.1" "Cucumber for Emacs.")

depends-on

Add a runtime dependency.

(depends-on NAME VERSION)

Example:

(depends-on "magit" "0.8.1")

development

Set scope to development dependencies.

(development [DEPENDENCIES])

Example:

(development
 (depends-on "ecukes" "0.2.1")
 (depends-on "espuds" "0.1.0"))

Example

Local Emacs installation

(source "melpa" http://melpa.milkbox.net/packages/")

(depends-on "magit")
(depends-on "drag-stuff")
(depends-on "wrap-region")

Package development

(source "melpa" "http://melpa.milkbox.net/packages/")

(package "ecukes" "0.2.1" "Cucumber for Emacs.")

(depends-on "ansi")

(development
 (depends-on "el-mock")
 (depends-on "ert"))

I still don't get it, give me some real examples

These are some projects using Carton:

Contribution

Be sure to!

Run the tests with:

$ make

carton's People

Contributors

rejeep avatar

Watchers

Kelly avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.