Skip to content

Commit

Permalink
Fixed directory link, removed segment on ligatures, some grammatical …
Browse files Browse the repository at this point in the history
…changes, fixed integer usage for the segment on frame rates, changed brackets to parenthesis.
  • Loading branch information
ChelseaChX committed Feb 1, 2023
1 parent d8f51dc commit 5f511bd
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions docs/docs/learn/shards/coding-with-shards.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ In this chapter, we will be learning how to code with Shards so that you can wri

## The shard

A shard in its most basic code form consists of its name surrounded by brackets.
A shard in its most basic code form consists of its name surrounded by parentheses.

![Some shard examples.](assets/shards-examples.png)

Expand Down Expand Up @@ -191,7 +191,7 @@ How you assign data to variables depends on the variable type. The main differen
- Global: The variable is known throughout the entire Mesh.

!!! note "Local vs Global"
We will learn more about this later in the section about [Scope](./working-with-data/#scope) in Shards.
We will learn more about this later in the section about [Scope](../working-with-data/#scope) in Shards.

Here are the variable types and the symbols used to create and assign to them:

Expand All @@ -210,9 +210,6 @@ In summary:

- Use `>` to update variable values.

!!! note "Ligatures"
Some fonts will combine characters into a ligature. ">=" can appear as the ligature `>=`, while ">==" will appear as `>==`.

!!! note "Alias"
Some shards have an alias to reduce your code's verbosity. They can represent shards with defined settings, as you will see in `Setup` below.

Expand Down Expand Up @@ -353,7 +350,7 @@ A Wire's lifetime ends once the final shard within it has been executed. To keep

![A Looped Wire is kept alive even after the final shard is executed.](assets/what-is-a-looped-wire.png)

A Looped Wire will continue running until exit conditions have been met.
A Looped Wire will continue running until its exit conditions have been met.

!!! note
You will learn more about the entering and exiting of Looped Wires in the next chapter!
Expand Down Expand Up @@ -404,15 +401,15 @@ When the Mesh is run, the Wires are executed in sequence and your program is sta

- The interval between each iteration of the Mesh.

- The maximum number of iterations, used only for Debugging purposes.
- The maximum number of iterations, typically used for Debugging purposes.

!!! note
If your program has animations, we recommend that you set the first value to `(/ 1 60)` which emulates 60 frames per second (60 FPS).
If your program has animations, we recommend that you set the first value to `(/ 1.0 60.0)` which emulates 60 frames per second (60 FPS).

=== "Running a Mesh at 60 FPS"

```{.clojure .annotate linenums="1"}
(run mesh-name (/ 1 60))
(run mesh-name (/ 1.0 60.0))
```

Let us now take a look at how a basic Shards program will look like!
Expand Down

0 comments on commit 5f511bd

Please sign in to comment.