Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 2.18 KB

README.md

File metadata and controls

38 lines (26 loc) · 2.18 KB
Raw

i3bb package repository

Primary package repository for the i3bb tool.

This repository contains a list of public i3blocks blocklets that can be installed by name using i3bb. The goal of this repo is to maintain a discoverable index of quality blocklets that can easily be maintained by the i3blocks community.

This repository was inspired by the Oh My Fish packages repository.

Repository format

Packages are referenced in the repository using property files located in the packages/ directory. The actual code of each package is stored in separate, individual Git repositories maintaned by the package mantainer themselves. This keeps control of the package in the owner's hands, but still allows easy sharing of the package.

The name of each property file indicates the package name, and the various properties in the file describe the package and how it can be installed. These are the properties currently used:

  • type: The type of package. Currently only blocklet.
  • repository: A cloneable Git URL to the package source repository.
  • maintainer: The name and email of the maintainer of the package.
  • description: A short description of the package.

Submitting a package

Want to add your own package to the public repository? First, make a fork of this Git repository. Then create a package description file inside the packages/ directory. The file name should be the name of your package without any file extensions, and should contain at least these properties:

type = blocklet
repository = YOUR-PACKAGE-URL
maintainer = YOUR-NAME <YOUR-EMAIL>
description = YOUR-PACKAGE-DESCRIPTION

Be sure to use a cloneable Git URL for your package.

Once you've created and committed your package description file, open a pull request with your change, and the repository maintainers will review your submission and merge it in to the main repo.

Once your pull request is merged, your package will be immediately available for all users to install!