Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SHARD.YAML(5)			 File Formats			 SHARD.YAML(5)

NAME
       shard.yml - metadata for	crystal	applications and libraries

SYNOPSYS
       shard.yml

DESCRIPTION
       The  file shard.yml is actually a YAML file with	metadata about a Crys-
       tal application or library. It must contain its name  and  version  and
       may contain a description, license, a list of dependencies and develop-
       ment dependencies.

REQUIRED ATTRIBUTES
       name   The name of the project.

       version
	      The version number of the	project.

OPTIONAL ATTRIBUTES
       authors
	      A	list of	authors, along with their contact email	(optional).

       description
	      A	single line description	of the project.

       license
	      An OSI license name or an	URL to a license file.

       dependencies
	      A	list of	required dependencies.

       development_dependencies
	      A	list of	dependencies required to work on the project, but  not
	      necessary	to build and run the project.

       scripts
	      Script hooks to run. Only	postinstall is supported.

DEPENDENCY ATTRIBUTES
       path   Local path to the	dependency.

       git    Git repository URL.

       github GitHub repository	URL as user/repo.

       bitbucket
	      Bitbucket	repository URL as user/repo.

       version
	      Version  requirement. It may be prefixed by one of the following
	      operators: _, _=,	_, _= or ~_. It	may also be  *	to  match  all
	      versions (default).

       branch Install the specified branch of a	Git dependency.

       commit Install the specified commit of a	Git dependency.

       tag    Install the specified tag	of a Git dependency.

EXAMPLE
       name: shards
       version:	1.2.3

       authors:
	 - Julien Portalier <julien@example.com>

       description: |
	 Dependency manager for	the Crystal Language

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

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

       scripts:
	 postinstall: make ext

       license:	MIT

AUTHOR
       Written by Julien Portalier.

SEE ALSO
       shards(1)

shards 0.9.0			September 2015			 SHARD.YAML(5)

NAME | SYNOPSYS | DESCRIPTION | REQUIRED ATTRIBUTES | OPTIONAL ATTRIBUTES | DEPENDENCY ATTRIBUTES | EXAMPLE | AUTHOR | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=shard.yml&sektion=5&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help