Skip to content

Commit c3ae2e2

Browse files
Merge pull request #40 from jonathanrocher/update_readme
Update stages in README.
2 parents c2169d0 + 9755357 commit c3ae2e2

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ the process, attendees will learn how to design clean, maintainable and
1616
scalable applications, and package them into an installer.
1717

1818
## Set up instructions
19+
First step to set yourself up is to clone this repository
20+
```commandline
21+
git clone [email protected]:jonathanrocher/ets_tutorial.git
22+
```
1923

2024
### Requirements
2125

@@ -37,6 +41,10 @@ edm shell -e ets_tutorial
3741
edm install pandas matplotlib traits traitsui scikits.image pillow pyqt5 ipython
3842
```
3943

44+
```commandline
45+
python etstool.py build
46+
```
47+
4048
### Conda users
4149
[TODO]
4250

@@ -64,24 +72,24 @@ During the tutorial, don't hesitate to ask for help:
6472

6573
## Outline of the tutorial
6674
The tutorial will guide you through all the stages from a basic python script
67-
(stage 0) to a fully packaged and installable application (stage 8). The
75+
(stage 1) to a fully packaged and installable application (stage 8). The
6876
included exercises will walk you through developing the primary product of
69-
each stage.
77+
each stage.
7078
A solution is available for each exercise, though, to ensure all participants
7179
are able to reach the end goal.
7280

73-
- step 0: python script
74-
- step 1: more robust script with ETS-Traits
75-
- step 2: package management tools: etstool, unit test and CI [OPTIONAL]
81+
- step 1: python script
82+
- step 2: more robust script with ETS-Traits
7683
- step 3: GUI: first traitsUI views
7784
- step 4: pyface application: tree navigator and double-click on an image to
7885
display the traitsUI view of the image.
79-
- step 5: pyface application:
86+
- step 5: Fuller pyface application:
8087
- add folder editor to display a table of metadata for all images inside
8188
- add button to launch the face detection on all images
8289
- add widgets to filter images
83-
- step 6: pyface application (adaptation to build central pane editors) [OPTIONAL]
84-
- step 7: pyface application: background run with traits-futures [OPTIONAL]
90+
- INTERLUDE: code structure for scalability
91+
- step 6: pyface application: adding menu and branding
92+
- step 7: pyface application: advanced features [OPTIONAL]
8593
- step 8: 1-click installer
8694

8795

0 commit comments

Comments
 (0)