Preston_PLB
/
bubbletea
forked from Mirrors/bubbletea
1
0
Fork 0
Code Pull Requests Activity

Friendlier headers in the basics tutorial

This commit is contained in:
Christian Rocha 2020-07-23 22:17:35 -04:00
parent 7e36944c3f
commit f1186b011b
No known key found for this signature in database
GPG Key ID: D6CC7A16E5878018
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
tutorials/basics/README.md
View File

@ -51,7 +51,7 @@ It can be any type, but a `struct` usually makes the most sense.
} }
``` ```
## Initialize ## The Initialization Function
Next we'll define a function that will initialize our application. An Next we'll define a function that will initialize our application. An
initialize function returns a model representing our application's initial initialize function returns a model representing our application's initial
@ -77,7 +77,7 @@ translates to "no command."
} }
``` ```
## Update ## The Update Function
Next we'll define the update function. The update function is called when Next we'll define the update function. The update function is called when
"things happen." It's job is to look at what has happened and return an updated "things happen." It's job is to look at what has happened and return an updated
@ -147,7 +147,7 @@ You may have noticed that "ctrl+c" and "q" above return a `tea.Quit` command
with the model. That's a special command which instructs the Bubble Tea runtime with the model. That's a special command which instructs the Bubble Tea runtime
to quit, effectively exiting the program. to quit, effectively exiting the program.
## The View ## The View Function
At last, it's time to render our UI. Of all the functions, the view is the At last, it's time to render our UI. Of all the functions, the view is the
simplest. A model, in it's current state, comes in and a `string` comes out. simplest. A model, in it's current state, comes in and a `string` comes out.
@ -191,7 +191,7 @@ for you.
} }
``` ```
## All together now ## All Together Now
The last step is to simply run our program. We pass our functions to The last step is to simply run our program. We pass our functions to
`tea.NewProgram` and let it rip: `tea.NewProgram` and let it rip:
@ -206,7 +206,7 @@ The last step is to simply run our program. We pass our functions to
} }
``` ```
## What's next? ## What's Next?
This tutorial covers the basics of building an interactive terminal UI, but This tutorial covers the basics of building an interactive terminal UI, but
in the real world you'll also need to perform I/O. To learn about that have a in the real world you'll also need to perform I/O. To learn about that have a

2
tutorials/commands/README.md
View File

@ -197,7 +197,7 @@ that returns a command. For example:
Just make sure you do as much work as you can in the innermost function, because Just make sure you do as much work as you can in the innermost function, because
that's the one that runs asynchronously. that's the one that runs asynchronously.
n
## Anyway, Now What? ## Anyway, Now What?
After doing this tutorial and [the previous one][basics] you should be ready to After doing this tutorial and [the previous one][basics] you should be ready to