Skip to content

Commit d737c5c

Browse files
authored
Update README.md
1 parent 5d74bdc commit d737c5c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

_internal/_template/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,19 @@ poetry run python example.py # Run the example
2020

2121
</details>
2222

23+
We follow this procedure to create consistent, high volume content.
24+
25+
1. Come up with a short readable slug, e.g. `generate-json` and a title.
26+
2. Create a folder in the [examples repo](https://github.com/SubstrateLabs/examples), copying this folder
27+
3. Write the code in TS or Python, and keep it simple. Ideally it’s just a script with no additional dependencies.
28+
1. Consider creating illustrative variations of the script (e.g. `ComputeText` and `MultiComputeText` - [example](https://github.com/SubstrateLabs/examples/tree/main/basics/generate-text))
29+
2. Translate your script to the other language. (TODO: automated translation with Substrate)
30+
3. Make sure both examples run and produce simple polished output.
31+
4. Simplify the code
32+
1. Wrap lines (multi-line node declarations are easier to read)
33+
2. Consider inlining variables
34+
4. Fill out this README with walkthrough text and generate new image assets.
35+
2336
![hero](hero.png)
2437

2538
To generate text with an LLM, use [`ComputeText`](https://www.substrate.run/nodes#ComputeText).

0 commit comments

Comments
 (0)