Skip to content

Commit

Permalink
docs: use find instead of tree in the example
Browse files Browse the repository at this point in the history
  • Loading branch information
hishamhm committed Jul 20, 2023
1 parent ee60150 commit 41cc391
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions docs/examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,6 @@ examples are provided; where each example has:
In all of these examples it is assumed that the root directory is 'examples'.

The use of 'tree' command is only for illustration in these notes. The user does
*not* need to use the 'tree' command.

## Files

This example demonstrates `cyan init` to create a Teal project, as well as the
Expand All @@ -37,19 +34,19 @@ is the standard project layout.

```
examples> cd files
files> tree .
files> find .
.
├── build
├── src
└── tlconfig.lua
./build
./src
./tlconfig.lua
```

### Create main.tl

In these examples `main.tl` will be the program that gets run. In other
examples you will have modules that are called from main.

Create [src/main.tl](files/src/main.tl)
Create [src/main.tl](files/src/main.tl).

The file handles appear like this in main.tl

Expand Down Expand Up @@ -86,11 +83,11 @@ And now the project directories look like...
```
files> tree .
.
├── build
│   └── main.lua
├── src
│   └── main.tl
└── tlconfig.lua
./build
./build/main.lua
./src
./src/main.tl
./tlconfig.lua
```

### Run the Project
Expand Down

0 comments on commit 41cc391

Please sign in to comment.