diff options
| author | Fuwn <[email protected]> | 2022-05-15 23:44:53 -0700 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2022-05-15 23:44:53 -0700 |
| commit | 242b0b9591fa4fd5f8b4a45ec4c179f451c62c14 (patch) | |
| tree | 6dcc82c1e87725224bc3dcd22c974ab0775f4c7f /README.md | |
| parent | docs(license): add license for vergen (diff) | |
| download | chorus-242b0b9591fa4fd5f8b4a45ec4c179f451c62c14.tar.xz chorus-242b0b9591fa4fd5f8b4a45ec4c179f451c62c14.zip | |
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f16ad9d --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +<h1 align="center">Chorus</h1> + +<p align="center">Cargo for COBOL</p> + +[](https://crates.io/crates/chorus) +[](https://github.com/Fuwn/chorus/actions/workflows/check.yaml) + +Chorus is a Cargo-like utility for building and distributing COBOL packages. + +Chorus is under heavy development and functions, kinda. It is nowhere near +finished, but few features work. + +## Installation + +```shell +$ cargo install --force --git https://github.com/Fuwn/chorus +``` + +## Usage + +### Creating a new Chorus package + +```shell +$ chorus new your_project_name +``` + +### Building a Chorus package + +```shell +$ chorus build --path your_project_name +``` + +## License + +This project is licensed with the +[GNU General Public License v3.0 +](https://github.com/Fuwn/rust-crate-template/blob/main/LICENSE). |