Skip to content

Commit c2f6e6f

Browse files
committed
Update README.md and reorganize examples
1 parent 08a7e96 commit c2f6e6f

File tree

3 files changed

+23
-1
lines changed

3 files changed

+23
-1
lines changed

README.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,26 @@
66

77
Carlo is named after Blessed Carlo Acutis, an Italian Catholic website designer and the patron of computer programmers. He succumbed to leukemia on October 12, 2006, and was beatified by the Catholic Church on October 10, 2020.
88

9-
You may read more about Carlo Acutis [on Wikipedia](https://en.wikipedia.org/wiki/Carlo_Acutis).
9+
You may read more about Carlo Acutis [on Wikipedia](https://en.wikipedia.org/wiki/Carlo_Acutis).
10+
11+
## Package Structure
12+
13+
The complete Carlo language is contained in the `carlo` workspace. The `carlo` workspace is composed of a series of Rust crates (packages).
14+
15+
- `carlotk`, the Carlo language toolkit, containing the Carlo language parser, CLI argument parser, and other utilities,
16+
17+
- `carlo-help`, the Carlo language help utility,
18+
19+
- `carlo-repl`, the Carlo language REPL,
20+
21+
- `carlo-run`, the Carlo langauge execution subcommand,
22+
23+
- `carlo-latex`, the Carlo LaTeX emitter, and
24+
25+
- `carlo-version`, the Carlo language version subcommand.
26+
27+
These packages are joined together in the `src/main.rs` executable, which invokes `carlotk::include_subcommands` macro to build the full `carlo` binary.
28+
29+
## License
30+
31+
The Carlo Language and all of its constitutive crates are licensed under the MIT license.

test.cl examples/test/test.cl

File renamed without changes.

test.tex examples/test/test.tex

File renamed without changes.

0 commit comments

Comments
 (0)