Add docs/V1_16_PACKAGES_PROJECTS.md from Claro v1.17.26 zip
This commit is contained in:
@@ -0,0 +1,94 @@
|
||||
# Claro v1.17.26 - Packages and Projects
|
||||
|
||||
Claro v1.17.26 makes projects and packages safer and more useful while keeping the beginner syntax simple.
|
||||
|
||||
## Create a project
|
||||
|
||||
```bash
|
||||
claro new MyProject
|
||||
cd MyProject
|
||||
claro run
|
||||
```
|
||||
|
||||
A new project contains:
|
||||
|
||||
```text
|
||||
main.claro
|
||||
claro.project
|
||||
claro.lock
|
||||
packages/
|
||||
README.md
|
||||
```
|
||||
|
||||
## Project file
|
||||
|
||||
`claro.project` is intentionally plain text:
|
||||
|
||||
```text
|
||||
name: MyProject
|
||||
main: main.claro
|
||||
version: v1.17.26
|
||||
packages:
|
||||
package: text
|
||||
package: sdl
|
||||
```
|
||||
|
||||
## Package commands
|
||||
|
||||
```bash
|
||||
claro package init
|
||||
claro package add text
|
||||
claro package remove text
|
||||
claro package list
|
||||
claro package doctor
|
||||
claro package lock
|
||||
```
|
||||
|
||||
`claro package add NAME` creates a local folder:
|
||||
|
||||
```text
|
||||
packages/NAME/
|
||||
claro.package
|
||||
README.md
|
||||
```
|
||||
|
||||
## Safety rules
|
||||
|
||||
Package names may use only:
|
||||
|
||||
```text
|
||||
letters
|
||||
numbers
|
||||
dash
|
||||
underscore
|
||||
```
|
||||
|
||||
This means simple names like these are allowed:
|
||||
|
||||
```text
|
||||
text
|
||||
sdl
|
||||
net_tools
|
||||
my-package
|
||||
```
|
||||
|
||||
Unsafe names are rejected:
|
||||
|
||||
```text
|
||||
../bad
|
||||
folder/name
|
||||
bad name
|
||||
```
|
||||
|
||||
## Why this matters
|
||||
|
||||
Packages are important for Claro's future, but the workflow must stay friendly:
|
||||
|
||||
```text
|
||||
make a project
|
||||
add a package
|
||||
run the project
|
||||
check the project
|
||||
```
|
||||
|
||||
No complicated setup should be needed for a beginner.
|
||||
Reference in New Issue
Block a user