1
1
mirror of https://github.com/ProvableHQ/leo.git synced 2024-12-18 23:41:38 +03:00
leo/package/README.md

31 lines
1016 B
Markdown
Raw Normal View History

2020-12-30 07:28:39 +03:00
# leo-package
2021-02-11 09:27:37 +03:00
[![Crates.io](https://img.shields.io/crates/v/leo-package.svg?color=neon)](https://crates.io/crates/leo-package)
[![Authors](https://img.shields.io/badge/authors-Aleo-orange.svg)](../AUTHORS)
[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](./LICENSE.md)
2021-07-19 19:01:22 +03:00
## Description
2020-12-30 07:28:39 +03:00
2021-07-19 19:01:22 +03:00
This module defines the structure of a Leo project package. And describes behavior of package internals, such
as Leo Manifest (Leo.toml), Lock File (Leo.lock), source files and imports.
Mainly used by Leo binary.
## Structure
Each directory in this crate mirrors a corresponding file generated in a new Leo project package:
```bash
2021-07-19 19:01:22 +03:00
package/src
├── errors # crate level error definitions
├── imports # program imports management
├── inputs # program inputs directory
├── outputs # program outputs directory
├── root # program root: Leo.toml, Leo.lock
└── source # source files directory
```
## Testing
Package features functional tests in the `tests/` directory.