aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
blob: dd5a313a111e0a8482f910d5f82cd8c58cfda0b5 (plain)
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
# Shirabe

![Shirabe logo](./logo.svg)

Shirabe is a port of [Composer](https://github.com/composer/composer), the dependency manager for PHP, written in Rust.

It aims at 100% compatibility with Composer, including the plugin API.

*WORK IN PROGRESS*: while full compatibility is the goal, the project is at an early stage and still has many incompatibilities and bugs. See [known incompatibilities](./docs/known-incompatibilities.md) for the differences that will remain intentionally.


## Build

```
$ git submodule update --init
$ cargo build --release
```


## Test

```
$ cargo test
```


## License

See [LICENSE.md](./LICENSE.md).