Skip to content

Latest commit

 

History

History
195 lines (164 loc) · 9.32 KB

README.md

File metadata and controls

195 lines (164 loc) · 9.32 KB
Raw

   

Summary

Bee is an open source build automation tool that focuses on conventions, type safety and performance. Project and build task definitions are written in Java, ensuring flexible extensibility for programmers.

Minimize settings

Use default values to minimize the number of items that need to be set as much as possible. Also, all settings are type-safe and completion, so you don't have to search for minor settings in the documentation.

Fast execution

All tasks are executed in parallel, and all output is cached and reused.

Repository oriented

It recognizes source code and package repositories and automates the entire lifecycle from development to release.

Install by script

Open your terminal and execute the following command to install bee.

In Linux / MacOS

curl -Ls https://git.io/install-bee | bash

In Windows

curl -Ls https://git.io/install-bee -o install.bat && install

After installation is complete, verify that the tool was installed successfully by running:

bee -v

Basic Usage

Once installed, you can start using Bee by running the following commands:

Setup with your IDE

bee ide

Install library into local repository

bee install

back to top

Prerequisites

Bee runs on all major operating systems and requires only Java version 23 or later to run. To check, please run java -version on your terminal.

back to top

Install

For any code snippet below, please substitute the version given with the version of Bee you wish to use.

Maven

Add JitPack repository at the end of repositories element in your build.xml:

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

Add it into in the dependencies element like so:

<dependency>
    <groupId>com.github.teletha</groupId>
    <artifactId>bee</artifactId>
    <version>0.57.0</version>
</dependency>

Gradle

Add JitPack repository at the end of repositories in your build.gradle:

repositories {
    maven { url "https://jitpack.io" }
}

Add it into the dependencies section like so:

dependencies {
    implementation 'com.github.teletha:bee:0.57.0'
}

SBT

Add JitPack repository at the end of resolvers in your build.sbt:

resolvers += "jitpack" at "https://jitpack.io"

Add it into the libraryDependencies section like so:

libraryDependencies += "com.github.teletha" % "bee" % "0.57.0"

Leiningen

Add JitPack repository at the end of repositories in your project.clj:

:repositories [["jitpack" "https://jitpack.io"]]

Add it into the dependencies section like so:

:dependencies [[com.github.teletha/bee "0.57.0"]]

Bee

Add it into your project definition class like so:

require("com.github.teletha", "bee", "0.57.0");

back to top

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

The overwhelming majority of changes to this project don't add new features at all. Optimizations, tests, documentation, refactorings -- these are all part of making this product meet the highest standards of code quality and usability. Contributing improvements in these areas is much easier, and much less of a hassle, than contributing code for new features.

Bug Reports

If you come across a bug, please file a bug report. Warning us of a bug is possibly the most valuable contribution you can make to Bee. If you encounter a bug that hasn't already been filed, please file a report with an SSCCE demonstrating the bug. If you think something might be a bug, but you're not sure, ask on StackOverflow or on bee-discuss.

back to top

Dependency

Bee depends on the following products on runtime.

back to top

License

Copyright (C) 2024 The BEE Development Team

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

back to top