Skip to content

Commit

Permalink
Did a pass on README
Browse files Browse the repository at this point in the history
  • Loading branch information
marianopeck committed Jun 2, 2020
1 parent fac2ae8 commit ae81a9d
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</p>


UI Eventing Framework to use for SUnit Testing. This allows users to also write SUnit Test for GUI components.
UI Eventing Framework to use for SUnit Testing. This allows users to also write SUnit Test for GUI components.

## License
- The code is licensed under [MIT](LICENSE).
Expand All @@ -28,18 +28,21 @@
1. Install [VA Smalltalk 9.2.1 or newer](https://www.instantiations.com/products/vasmalltalk/download.html).
2. Install Tonel support in your development image following [this guide](https://github.com/vasmalltalk/tonel-vast#installation).
3. Clone this repository.
4. Load the Configuration Map `VastSUnitExtensions` either from the context menu of the Configuration Maps Browser ("*Import*" -> "*Load Configuration Maps from Tonel repository...*" -> select path to root `sunit-extensions-vast` local repo) or via a script:
4. The easiest and recommended approach is to install it via a script:

```smalltalk
| loader path |
path := (CfsPath named: '<insert path to root sunit-extensions-vast local repo here>').
loader := TonelLoader readFromPath: path.
loader
beUnattended.
beUnattended; "do not prompt and use all defaults"
useGitVersion.
loader loadAllMapsWithRequiredMaps.
```

Or you can load the Configuration Map `VastSUnitExtensions` from the context menu of the Configuration Maps Browser: `"Import"` -> `"Load Configuration Maps from Tonel repository..."` -> select path to root `sunit-extensions-vast` local repo. This will open a dialog and will use convenient defaults for the load. Refer to [its documentation](https://github.com/instantiations/tonel-vast#using-gui-menus) for more details.

5. Optionally run the SUnit tests included in the map `VastSUnitExtensions` to ensure correct installation. One easy way is to right-click on the `VastSUnitExtensions` map name in the Name pane (as opposed to version pane ) and then select `Test Loaded Applications`.

## Quick Start

Expand Down

0 comments on commit ae81a9d

Please sign in to comment.