Add links to example Readme

This commit is contained in:
Alexandre Bury 2017-11-17 14:28:18 -08:00
parent 9ae26fc368
commit e3b0ecbbd9

View File

@ -5,91 +5,91 @@ various aspects of the library.
To run an example, use `cargo run --example EXAMPLE_NAME`. To run an example, use `cargo run --example EXAMPLE_NAME`.
## `hello_world` ## [`hello_world`](hello_world.rs)
Simplest example possible, it will show you the starting point of a basic Simplest example possible, it will show you the starting point of a basic
Cursive application. Cursive application.
## `dialog` ## [`dialog`](dialog.rs)
This example wraps the text in a `Dialog` view, showing the basic idea of view This example wraps the text in a `Dialog` view, showing the basic idea of view
composition. composition.
## `lorem` ## [`lorem`](lorem.rs)
This example loads a large text file to show scrolling behaviour. It also This example loads a large text file to show scrolling behaviour. It also
includes greek and japanese characters to show non-ascii support. includes greek and japanese characters to show non-ascii support.
## `edit` ## [`edit`](edit.rs)
Here we have an `EditView` to get input from the user, and use that input in Here we have an `EditView` to get input from the user, and use that input in
the next view. It shows how to identify a view with an ID and refer to it the next view. It shows how to identify a view with an ID and refer to it
later. later.
## `mutation` ## [`mutation`](mutation.rs)
This example modifies the content of an existing view. This example modifies the content of an existing view.
## `linear` ## [`linear`](linear.rs)
This example uses a `LinearView` to put multiple views side-by-side. This example uses a `LinearView` to put multiple views side-by-side.
## `menubar` ## [`menubar`](menubar.rs)
Here we learn how to create a menubar at the top of the screen, and populate Here we learn how to create a menubar at the top of the screen, and populate
it with static and dynamic entried. it with static and dynamic entried.
## `logs` ## [`logs`](logs.rs)
This example defines a custom view to display asynchronous input from a This example defines a custom view to display asynchronous input from a
channel. channel.
## `key_codes` ## [`key_codes`](key_codes.rs)
This example uses a custom view to print any input received. Can be used as a This example uses a custom view to print any input received. Can be used as a
debugging tool to see what input the application is receiving. debugging tool to see what input the application is receiving.
## `select` ## [`select`](select.rs)
This example uses a `SelectView` to have the user pick a city from a long list. This example uses a `SelectView` to have the user pick a city from a long list.
## `list_view` ## [`list_view`](list_view.rs)
This shows a use of a `ListView`, used to build simple forms. This shows a use of a `ListView`, used to build simple forms.
## `text_area` ## [`text_area`](text_area.rs)
This example uses a `TextArea`, where the user can input a block of text. This example uses a `TextArea`, where the user can input a block of text.
## `theme` ## [`theme`](theme.rs)
This loads a theme file at runtime to change default colors. This loads a theme file at runtime to change default colors.
## `theme_manual` ## [`theme_manual`](theme_manual.rs)
Instead of loading a theme file, this manually sets various theme settings. Instead of loading a theme file, this manually sets various theme settings.
## `terminal_default` ## [`terminal_default`](terminal_default.rs)
This example shows the effect of the `Color::TerminalDefault` setting. This example shows the effect of the `Color::TerminalDefault` setting.
## `colors` ## [`colors`](colors.rs)
This example draws a colorful square to show off true color support. This example draws a colorful square to show off true color support.
## `refcell_view` ## [`refcell_view`](refcell_view.rs)
Here we show how to access multiple views concurently through their IDs. Here we show how to access multiple views concurently through their IDs.
## `progress` ## [`progress`](progress.rs)
This shows how to send information from an asynchronous task (like a download This shows how to send information from an asynchronous task (like a download
or slow computation) to update a progress bar. or slow computation) to update a progress bar.
## `radio` ## [`radio`](radio.rs)
This shows how to use `RadioGroup` and `RadioButton`. This shows how to use `RadioGroup` and `RadioButton`.
## `slider` ## [`slider`](slider.rs)
This is a demonstration of the `SliderView`. This is a demonstration of the `SliderView`.