mirror of
https://github.com/ProvableHQ/leo.git
synced 2024-11-26 16:37:30 +03:00
update leo-package README
This commit is contained in:
parent
9cc2a8e2d1
commit
0b338d7d78
@ -4,6 +4,27 @@
|
|||||||
[![Authors](https://img.shields.io/badge/authors-Aleo-orange.svg)](../AUTHORS)
|
[![Authors](https://img.shields.io/badge/authors-Aleo-orange.svg)](../AUTHORS)
|
||||||
[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](./LICENSE.md)
|
[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](./LICENSE.md)
|
||||||
|
|
||||||
This module defines the structure of a Leo project package.
|
## Description
|
||||||
|
|
||||||
Each file in this directory mirrors a corresponding file generated in a new Leo project package.
|
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:
|
||||||
|
|
||||||
|
```
|
||||||
|
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.
|
||||||
|
Loading…
Reference in New Issue
Block a user