Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README-templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# File Templates

`workflow-file-templates.zip` can be imported into Android Studio / IntelliJ IDEA to add a few Workflow-specific file templates, via _File > Manage IDE Settings > Import Settings…_.

To update the templates:

* edit them in the IDE (_Settings > Editor > File and Code Templates_)
* export them (_File > Manage IDE Settings > Import Settings…_), taking care to clear every checkbox except that for File Templates.
87 changes: 0 additions & 87 deletions fileTemplates/Stateful Workflow.kt

This file was deleted.

61 changes: 0 additions & 61 deletions fileTemplates/Stateless Workflow.kt

This file was deleted.

27 changes: 0 additions & 27 deletions install-templates.sh

This file was deleted.

24 changes: 2 additions & 22 deletions samples/tutorial/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,9 @@
# Tutorial

## Stale Docs Warning

**This tutorial is tied to an older version of Workflow, and relies on API that has been deprecated or deleted.**
The general concepts are the same, and refactoring to the current API is straightforward,
so it is still worthwhile to work through the tutorial in its current state until we find time to update it.
(Track that work [here](https://github.com/square/workflow-kotlin/issues/905)
and [here](https://github.com/square/workflow-kotlin/issues/884).)

Here's a summary of what has changed, and what replaces what:

- Use of `ViewRegistry` is now optional, and rare.
Have your renderings implement `AndroidScreen` or `ComposeScreen` to avoid it.
- The API for binding a rendering to UI code has changed as follows, and can all
be avoided if you use `ComposeScreen`:
- `ViewFactory<in RenderingT : Any>` is replaced by `ScreenViewFactory<in ScreenT : Screen>`.
-`LayoutRunner<RenderingT : Any>` is replaced by `ScreenViewRunner<in ScreenT : Screen>`.
- `LayoutRunner.bind` is replaced by `ScreenViewFactory.fromViewBinding`.
- `BackStackScreen` has been moved to package `com.squareup.workflow1.ui.navigation`.
- `EditText.updateText` and `EditText.setTextChangedListener` are replaced by `TextController`

## Overview

Oh hi! Looks like you want build some software with Workflows! It's a bit different from traditional
Android development, so let's go through building a simple little TODO app to get the basics down.
Android development, so let's go through building a simple little To-Do app to get the basics down.

## Layout

Expand All @@ -33,7 +13,7 @@ To help with the setup, we have created a few helper modules:

- `tutorial-views`: A set of 3 views for the 3 screens we will be building, `Welcome`, `TodoList`,
and `TodoEdit`.
- `tutorial-base`: This is the starting point to build out the tutorial. It contains layouts that host the views from `TutorialViews` to see how they display.
- `tutorial-base`: This is the starting point to build out the tutorial.
- `tutorial-final`: This is an example of the completed tutorial - could be used as a reference if
you get stuck.

Expand Down
Loading