bloomery 1.10.1

A lightweight, minimalist build system for Java written in Rust.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

<div>

# Bloomery

**A lightweight, minimalist build system for Java written in Rust.**

[![Rust Version](https://img.shields.io/badge/rust-1.70%2B-orange.svg)](https://www.rust-lang.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Crates.io](https://img.shields.io/crates/v/bloomery.svg)](https://crates.io/crates/bloomery)
[![Status](https://img.shields.io/badge/Status-Work%20in%20Progress-yellow.svg)](#)

</div>

---

Bloomery is an easy and minimalist build system for Java projects written in Rust.
It is designed to make creating, building and running simple Java projects easy and just working.

I started Bloomery because I am learning Java at school and wanted something similar to Maven, but much simpler.

I don't need millions of features, complicated configuration or a huge build system just to compile and run a small Java project. I also don't want to use a heavy IDE like IntelliJ just for basic Java development.

Bloomery is my attempt at making a small tool that does what I need and nothing more.

--- 

## Features

- **Easy to use**
- **Lightweight**
- **TOML configuration**
- **Single file execution**
- **Easily build and run .jar files**
- **Configurable output**
- **External dependencies to classpath**
- **Built in templates for different use-cases**
- **Install custom templates**

---

## Installation

To install bloomery on your system:

#### from crates.io:

```bash
cargo install bloomery
```

#### or install it from source:

clone the repo and change into it

```bash
git clone https://github.com/Kiwilus/bloomery.git && cd bloomery
```

install bloomery system wide

```bash
cargo install --path .
```

## Documentation

- [Usage](docs/usage.md)
- [Custom Templates](docs/custom-template.md)
- [Dependencies](docs/dependencies.md)

## How I use bloomery with zed

If you are Interessted how I use bloomery in zed

See the [Zed configuration](docs/zed-configuration.md).

## Requirements

- Rust
- JDK
- `javac`, `java` and `jar` in your PATH

## Contributing

Contributions are welcome!  
If you want to contribute, please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.

Bloomery is still a work in progress.