Skip to content
This repository has been archived by the owner on Nov 20, 2024. It is now read-only.

Latest commit

 

History

History
87 lines (59 loc) · 2.55 KB

README.md

File metadata and controls

87 lines (59 loc) · 2.55 KB
Raw

Shards

Dependency manager for the Crystal language.

Important

This fork is no longer supported or updated by Manas.Tech, therefore we have archived the repository.

The contents are still available readonly, and active Shards development still happens at crystal-lang/shards.

If you have further questions, please reach out on https://forum.crystal-lang.org or [email protected]

Usage

Crystal applications and libraries are expected to have a shard.yml file at their root looking like this:

name: shards
version: 0.1.0

dependencies:
  openssl:
    github: datanoise/openssl.cr
    branch: master

development_dependencies:
  minitest:
    git: https://github.com/ysbaddaden/minitest.cr.git
    version: ~> 1.0.0

license: MIT

When libraries are installed from Git repositories, the repository is expected to have version tags following the semver format, prefixed with a v. Examples: v1.2.3 or v2.0.0-rc1.

Please see the SPEC for more details about the shard.yml format.

Install

You can download a statically compiled 64bit executable of Shards for Linux or OS X from the releases page.

Alternatively you may download a source tarball from the same page (or clone the repository) then run make —or make release for an optimized build— and copy the newly generated bin/shards somewhere into your PATH. A good place is /usr/local/bin for example.

You are now ready to create a shard.yml for your projects (see the SPEC).

Simply run shards install to install your dependencies, or shards --help to list the other commands and their options.

Happy Hacking!

Requirements

These requirements are only for compiling Shards.

  • Crystal >= 0.8.0.

    Please refer to http://crystal-lang.org/docs/installation for instructions for your operating system.

  • libyaml

    On Debian/Ubuntu Linux you may install the libyaml-dev package.

    On Mac OS X you may install it using homebrew with brew install libyaml then make sure to have /usr/local/lib in your LIBRARY_PATH environment variable (eg: export LIBRARY_PATH="/usr/local/lib/lib:$LIBRARY_PATH"). Please adjust the path per your Homebrew installation.

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.