Skip to content

Commit 55bde97

Browse files
authored
Merge pull request #45 from oslabs-beta/tonyito-patch-1
Update README.md
2 parents 4aba93d + fe6d00d commit 55bde97

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,14 @@ Download for [MacOS](https://github.com/team-reactype/ReacType/releases/tag/Mac.
2020

2121
### How to use
2222

23+
- To enter **_Tutorial Mode_** navigate to 'Help' -> 'Tutotial'
24+
2325
- Open the application to start a new project. It will open in the root App component, with its name listed in the left panel and the component represented by the white box on the canvas.
24-
- To add a new component, type its name in the upper left panel, in the field '**Add class component**', and press enter.
26+
- **_Upload an image to use as template_** by clicking the button on the bottom left corner or through the windows menu under 'File -> Open Image'
27+
- To add a new component, type its name in the upper left panel, in the field '**Add component**', and press enter.
2528
- To render a component **_instance_** to the screen, first select the component, or _parent_, that the instance will be rendered within. This selected component will be represented in a new canvas view, with its own white box. Then press the plus button next to the component name. An instance, or _child_, representation will appear on the canvas.
29+
- To **_toggle the component to be class or functional_** click the 'Class?' switch and it will repopulate the code preview to reflect the change.
30+
- To **_toggle the component to be stateful_** click the 'State?' switch and it will repopulate the code preview to reflect the change. The application exported will use the 'useState' hook to allow for functional components to be stateful as well.
2631
- To add draggable **HTML elements**, select the image icons on the lower left panel.
2732

2833
![Gif of adding](https://imgur.com/sZloD8o.gif)
@@ -31,13 +36,15 @@ Download for [MacOS](https://github.com/team-reactype/ReacType/releases/tag/Mac.
3136

3237
![Gif of code preview & tree](https://imgur.com/KZb2UTO.gif)
3338

34-
- **_Props_** can be added to each component within its tab on bottom panel. Enter in a _key-value pair_, select its data _type_ and press the bottom 'ADD PROP'.
39+
- **_Props_** can be added to each component within its tab on bottom panel. Enter in a _name for the prop_, select its data _type_ and press the bottom 'ADD PROP'.
3540
- **_HTML Element Attributes_** of class name and ID can be added to each HTML element after an HTML element has been rendered to the canvas.
41+
- To **_edit code while in code preview_** press 'ENTER EDIT MODE'.
3642

3743
![Gif of attr & props](https://imgur.com/JgCiBE9.gif)
3844

3945
- To **_delete_** a _child_ or instance from the canvas, select the desired instance and either press the _delete_ key.
4046
- To **_delete_** a _component_, click the 'DELETE' button of the desired component in the left panel.
47+
- To **_edit_** a _component's name_, double click on the component's name, and press escape to cancel.
4148
- To _start over_, select the blue 'CLEAR WORKSPACE' button in the left panel. This will **clear the entire application**.
4249

4350
### To Export Files
@@ -56,18 +63,26 @@ Download for [MacOS](https://github.com/team-reactype/ReacType/releases/tag/Mac.
5663

5764
[Christian Padilla](https://linkedin.com/in/ChristianEdwardPadilla) [@ChristianEdwardPadilla](https://github.com/ChristianEdwardPadilla)
5865

66+
[Eliot Nguyen](https://www.linkedin.com/in/ibeeliot/) [@ibeeliot](https://github.com/ibeeliot)
67+
68+
[Jesse Zuniga](https://www.linkedin.com/in/jesse-zuniga/) [@jzuniga206](https://github.com/jzuniga206)
69+
5970
[Mitchel Severe](https://www.linkedin.com/in/misevere/) [@mitchelsevere](https://github.com/mitchelsevere)
6071

6172
[Natalie Vick](https://www.linkedin.com/in/vicknatalie/) [@natattackvick](https://github.com/natattackvick)
6273

6374
[Nel Malikova](https://www.linkedin.com/in/gmalikova/) [@gmal1](https://github.com/gmal1)
6475

76+
[Sean Sadykoff](https://www.linkedin.com/in/sean-sadykoff/) [@sean1292](https://github.com/sean1292)
77+
6578
[Shlomo Porges](https://linkedin.com/shlomoporges) [@shlomoporges](https://github.com/ShlomoPorges)
6679

6780
[Sophia Huttner](https://www.linkedin.com/in/sophia-huttner-68315975/) [@sophjean](https://github.com/sophjean)
6881

6982
[Tolga Mizrakci](https://linkedin.com/in/tolga-mizrakci) [@tolgamizrakci](https://github.com/tolgamizrakci)
7083

84+
[Tony Ito-Cole](www.linkedin.com/in/tony-ito-cole) [@tonyito](https://github.com/tonyito)
85+
7186
## To Run Your Own Version
7287

7388
- **Fork** and **Clone** Repository.

0 commit comments

Comments
 (0)