From 944c8e88c1cb037056098e9fe7076a92ee6fd9df Mon Sep 17 00:00:00 2001 From: Toalaah Date: Sun, 11 Jul 2021 14:15:31 +0200 Subject: [PATCH 1/9] Begin to update readme --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 48c67f9b..71d1e5a9 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,13 @@ [![Coverage Status](https://coveralls.io/repos/github/hpi-swa-teaching/AutoTDD/badge.svg?branch=dev)](https://coveralls.io/github/hpi-swa-teaching/AutoTDD?branch=dev) ## About -AutoTDD is an automated testing tool for continuously monitoring the test state of your project. You tests will be automatically executed when a method in your project changes. When a test fails, you will get instant feedback about what went wrong. It also displays current Travis build results. +The Test Auto Runner (AutoTDD) is an automated testing tool for continuously monitoring the status of your project's tests. AutoTDD enables you to automatically execute tests upon altering your projects's methods. When a test fails, you will get instant feedback on what went wrong. -![A screenshot of AutoTDD](https://spee.ch/d/screns.png) +![A screenshot of AutoTDD](https://i.imgur.com/EuCCRDX.png) ## Installation 1. Make sure you have [metacello-work](https://github.com/dalehenrich/metacello-work) installed. -2. Load the project with: +2. Make sure you have [OSProcess](http://wiki.squeak.org/squeak/708) installed. +3. Load the project with: ```smalltalk Metacello new baseline: 'AutoTDD'; @@ -17,10 +18,10 @@ Metacello new onConflict: [:ex | ex allow]; load ``` -Now you can open the **Test Auto Runner** via *Apps*. +You should now be able to open AutoTDD by clicking on *Test Auto Runner* via the *Apps* menu. -### Upgrading from v2 -If you are upgrading from v2 of AutoTDD, please make sure to close **all** traffic lights and windows **and** that no tests are running anymore, otherwise your image will probably crash. +### Upgrading from v2 / v3 +If you are upgrading from AutoTDD **v2** or **v3** please make sure to stop **all** currently running tests and close all AutoTDD-related windows. ## Sound Customizations If the [AutoTDD](https://github.com/hpi-swa-teaching/AutoTDD/tree/master/resources) folder is present in your `Resources` folder, you can use the following commands to reload AutoTDD's sounds into your image: @@ -28,6 +29,17 @@ If the [AutoTDD](https://github.com/hpi-swa-teaching/AutoTDD/tree/master/resourc ATDDSoundPlayer new generateSoundMethods ``` + +## FAQ + +### What permissions are needed for GitHub Actions Tokens? +Answer + +### What kind of tests is AutoTDD suited for? +Answer + +### How can I customize the test-runner? +Answer (move Sound customization here and mention theming) + ## Documentation -A more technical documentation can either be found in the class comments or here: -[Documentation](https://github.com/hpi-swa-teaching/AutoTDD/wiki) +A more technical documentation can either be found in the class comments or [here](https://github.com/hpi-swa-teaching/AutoTDD/wiki). From 64af1f6036f9013c123404e9a5ca8df50272b67c Mon Sep 17 00:00:00 2001 From: Benjamin Frost <58258541+Benjamin-Frost@users.noreply.github.com> Date: Fri, 16 Jul 2021 21:46:42 +0200 Subject: [PATCH 2/9] Add AutoTDD Banner --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 71d1e5a9..7fb29925 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# AutoTDD with GitHub Actions & Travis-CI Support +![AutoTDD_Banner](https://user-images.githubusercontent.com/58258541/126001012-dac234d9-e242-4ac0-86d1-0b227f237321.png) + [![CI](https://github.com/hpi-swa-teaching/AutoTDD/workflows/CI/badge.svg?branch=dev)](https://github.com/hpi-swa-teaching/AutoTDD/actions) [![Coverage Status](https://coveralls.io/repos/github/hpi-swa-teaching/AutoTDD/badge.svg?branch=dev)](https://coveralls.io/github/hpi-swa-teaching/AutoTDD?branch=dev) From 6012e9f07e250a2464b1c58ab20525cf3876365b Mon Sep 17 00:00:00 2001 From: Benjamin Frost <58258541+Benjamin-Frost@users.noreply.github.com> Date: Fri, 16 Jul 2021 22:08:33 +0200 Subject: [PATCH 3/9] Update README.md --- README.md | 48 +++++++++++++++++++++++++++++++++--------------- 1 file changed, 33 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 7fb29925..c0aa98db 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,28 @@ ![AutoTDD_Banner](https://user-images.githubusercontent.com/58258541/126001012-dac234d9-e242-4ac0-86d1-0b227f237321.png) +--- -[![CI](https://github.com/hpi-swa-teaching/AutoTDD/workflows/CI/badge.svg?branch=dev)](https://github.com/hpi-swa-teaching/AutoTDD/actions) -[![Coverage Status](https://coveralls.io/repos/github/hpi-swa-teaching/AutoTDD/badge.svg?branch=dev)](https://coveralls.io/github/hpi-swa-teaching/AutoTDD?branch=dev) +

+ + + + + + +

+ +## 💡 About -## About The Test Auto Runner (AutoTDD) is an automated testing tool for continuously monitoring the status of your project's tests. AutoTDD enables you to automatically execute tests upon altering your projects's methods. When a test fails, you will get instant feedback on what went wrong. ![A screenshot of AutoTDD](https://i.imgur.com/EuCCRDX.png) -## Installation -1. Make sure you have [metacello-work](https://github.com/dalehenrich/metacello-work) installed. -2. Make sure you have [OSProcess](http://wiki.squeak.org/squeak/708) installed. + +## 💾 Installation + +1. Make sure you have [ Metacello-Work](https://github.com/Metacello/metacello) installed. +2. Make sure you have [💿 OSProcess](http://wiki.squeak.org/squeak/708) installed. 3. Load the project with: + ```smalltalk Metacello new baseline: 'AutoTDD'; @@ -19,28 +30,35 @@ Metacello new onConflict: [:ex | ex allow]; load ``` -You should now be able to open AutoTDD by clicking on *Test Auto Runner* via the *Apps* menu. + +You should now be able to open AutoTDD by clicking on Test Auto Runner via the Apps menu. ### Upgrading from v2 / v3 + If you are upgrading from AutoTDD **v2** or **v3** please make sure to stop **all** currently running tests and close all AutoTDD-related windows. -## Sound Customizations -If the [AutoTDD](https://github.com/hpi-swa-teaching/AutoTDD/tree/master/resources) folder is present in your `Resources` folder, you can use the following commands to reload AutoTDD's sounds into your image: +## 🔊 Sound Customizations + +If the AutoTDD folder is present in your Resources folder, you can use the following commands to reload AutoTDD's sounds into your image: + ```smalltalk ATDDSoundPlayer new generateSoundMethods ``` - -## FAQ +## ☝️ FAQ ### What permissions are needed for GitHub Actions Tokens? -Answer + +> TODO: Answer ### What kind of tests is AutoTDD suited for? -Answer + +> TODO: Answer ### How can I customize the test-runner? -Answer (move Sound customization here and mention theming) + +> TODO: Answer (move Sound customization here and mention theming) ## Documentation -A more technical documentation can either be found in the class comments or [here](https://github.com/hpi-swa-teaching/AutoTDD/wiki). + +> A more technical documentation can either be found in the class comments or here: [AutoTDD Wiki](https://github.com/hpi-swa-teaching/AutoTDD/wiki). From a655ae39fd75a332e29d71eb3db89aaa52e4e652 Mon Sep 17 00:00:00 2001 From: Benjamin Frost <58258541+Benjamin-Frost@users.noreply.github.com> Date: Fri, 16 Jul 2021 22:14:54 +0200 Subject: [PATCH 4/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c0aa98db..d7249da5 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ If you are upgrading from AutoTDD **v2** or **v3** please make sure to stop **al ## 🔊 Sound Customizations -If the AutoTDD folder is present in your Resources folder, you can use the following commands to reload AutoTDD's sounds into your image: +If the `AutoTDD` folder is present in your `Resources` folder, you can use the following commands to reload AutoTDD's sounds into your image: ```smalltalk ATDDSoundPlayer new generateSoundMethods From af8c3fda09862615b84d84c23a966083037a7398 Mon Sep 17 00:00:00 2001 From: Samuel Kunst <38653851+Toalaah@users.noreply.github.com> Date: Sat, 17 Jul 2021 13:21:40 +0200 Subject: [PATCH 5/9] Complete FAQ, update installation section --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d7249da5..2e9d06e6 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,7 @@ The Test Auto Runner (AutoTDD) is an automated testing tool for continuously mon ## 💾 Installation 1. Make sure you have [ Metacello-Work](https://github.com/Metacello/metacello) installed. -2. Make sure you have [💿 OSProcess](http://wiki.squeak.org/squeak/708) installed. -3. Load the project with: +2. Load the project with: ```smalltalk Metacello new @@ -37,27 +36,28 @@ You should now be able to open AutoTDD by clicking on Test Auto Runner TODO: Answer +> GitHub Actions tokens require **repo** and **workflow** permissions. See the image below for a reference. + +![Test](https://user-images.githubusercontent.com/38653851/126034965-364d8e97-7de5-47a1-a42c-4ee5a62f73f1.png) ### What kind of tests is AutoTDD suited for? -> TODO: Answer +> AutoTDD runs respective tests as soon as any relevant files undergo changes. As such, your tests will run quite frequently. Due to this, it is not advised to use AutoTDD for obtrusive or long-winded tests. This especially includes GUI tests where windows are opened / closed frequently. ### How can I customize the test-runner? -> TODO: Answer (move Sound customization here and mention theming) +> AutoTDD supports customization for sounds as well as themes. To change feedback sounds AutoTDD, swap out the respective sound files in the `Resources/AutoTDD/sounds` directory and reload the sound player with: + +```smalltalk +ATDDSoundPlayer new generateSoundMethods +``` + +> AutoTDD also supports various color schemes depending on the currently selected theme in your image. To change the look and feel of the gui, select a new theme from `Extras 🠖 Themes & Colors` + ## Documentation From b0b61c3a7bba44230ed1802a4699c9ef45dca2f5 Mon Sep 17 00:00:00 2001 From: Samuel Kunst <38653851+Toalaah@users.noreply.github.com> Date: Sun, 18 Jul 2021 09:35:19 +0200 Subject: [PATCH 6/9] Continue improvements on readme --- README.md | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2e9d06e6..3dca54a0 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,16 @@ ## 💡 About -The Test Auto Runner (AutoTDD) is an automated testing tool for continuously monitoring the status of your project's tests. AutoTDD enables you to automatically execute tests upon altering your projects's methods. When a test fails, you will get instant feedback on what went wrong. +The Test Auto Runner (AutoTDD) is an automated testing tool which helps you continuously monitor the status of your project by enabling you to automatically run tests on changes to your project. When a test fails, you will get instant feedback on what went wrong. AutoTDD also supports integration with CI tools such as **GitHub Actions** and **Travis CI**. -![A screenshot of AutoTDD](https://i.imgur.com/EuCCRDX.png) +![A screenshot of AutoTDD](https://user-images.githubusercontent.com/38653851/126059400-d8b96865-1f08-4f6b-81e6-f919c3055424.png) ## 💾 Installation - + +### Via Metacello (recommended) + 1. Make sure you have [ Metacello-Work](https://github.com/Metacello/metacello) installed. -2. Load the project with: +2. In a new workspace load the project into your image by running: ```smalltalk Metacello new @@ -32,9 +34,18 @@ Metacello new You should now be able to open AutoTDD by clicking on Test Auto Runner via the Apps menu. -### Upgrading from v2 / v3 +### Via direct SAR-Installation + +1. Download the latest AutoTDD.sar file from the project's [Releases](https://github.com/hpi-swa-teaching/AutoTDD/releases). +2. Drag and drop AutoTDD.sar into your image and select install SAR. + +![Sar Popup](https://user-images.githubusercontent.com/38653851/126059197-f00de748-cbf6-466a-910d-bd5f8a4831bd.png) + +You should now be able to open AutoTDD by clicking on Test Auto Runner via the Apps menu. + +### 📦 Upgrading from v2 / v3 -If you are upgrading from AutoTDD **v2** or **v3** please make sure to stop **all** currently running tests and close all AutoTDD-related windows. +If you are upgrading from AutoTDD **v2** or **v3** please make sure to stop **all** currently running tests and close all AutoTDD-related windows before proceeding with the installation. ## ☝️ FAQ @@ -42,23 +53,23 @@ If you are upgrading from AutoTDD **v2** or **v3** please make sure to stop **al > GitHub Actions tokens require **repo** and **workflow** permissions. See the image below for a reference. -![Test](https://user-images.githubusercontent.com/38653851/126034965-364d8e97-7de5-47a1-a42c-4ee5a62f73f1.png) + ### What kind of tests is AutoTDD suited for? -> AutoTDD runs respective tests as soon as any relevant files undergo changes. As such, your tests will run quite frequently. Due to this, it is not advised to use AutoTDD for obtrusive or long-winded tests. This especially includes GUI tests where windows are opened / closed frequently. +> AutoTDD runs user-specified tests as soon as any relevant classes / methods undergo changes. As such, your tests will run quite frequently. Due to this, it is not advised to use AutoTDD for obtrusive or long-winded tests. This especially includes GUI tests where windows are opened / closed frequently. ### How can I customize the test-runner? -> AutoTDD supports customization for sounds as well as themes. To change feedback sounds AutoTDD, swap out the respective sound files in the `Resources/AutoTDD/sounds` directory and reload the sound player with: +> AutoTDD supports customization for sounds as well as themes. To change what sounds AutoTDD uses, swap out the respective files in the `Resources/AutoTDD/sounds` directory and reload the sound player with: ```smalltalk ATDDSoundPlayer new generateSoundMethods ``` -> AutoTDD also supports various color schemes depending on the currently selected theme in your image. To change the look and feel of the gui, select a new theme from `Extras 🠖 Themes & Colors` +> AutoTDD also supports various color schemes depending on the currently selected theme in your image. To change the look and feel of the GUI, select a new theme from `Extras 🠖 Themes & Colors` ## Documentation -> A more technical documentation can either be found in the class comments or here: [AutoTDD Wiki](https://github.com/hpi-swa-teaching/AutoTDD/wiki). +> A more detailed and technical documentation can either be found in the class comments under the [AutoTDD Wiki](https://github.com/hpi-swa-teaching/AutoTDD/wiki). From 02865a0e55881fd8866fa04db389b6774ebc41a4 Mon Sep 17 00:00:00 2001 From: Toalaah Date: Sun, 18 Jul 2021 11:30:14 +0200 Subject: [PATCH 7/9] Fix unicode bug --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3dca54a0..f7837dea 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ If you are upgrading from AutoTDD **v2** or **v3** please make sure to stop **al ATDDSoundPlayer new generateSoundMethods ``` -> AutoTDD also supports various color schemes depending on the currently selected theme in your image. To change the look and feel of the GUI, select a new theme from `Extras 🠖 Themes & Colors` +> AutoTDD also supports various color schemes depending on the currently selected theme in your image. To change the look and feel of the GUI, select a new theme from `Extras → Themes & Colors` ## Documentation From 9e8f3e66ae4d4e881ca242b37fd93881433e3d07 Mon Sep 17 00:00:00 2001 From: Toalaah Date: Sun, 18 Jul 2021 14:44:37 +0200 Subject: [PATCH 8/9] minor fixes & consistency changes --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f7837dea..cb807283 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ The Test Auto Runner (AutoTDD) is an automated testing tool which helps you cont ## 💾 Installation -### Via Metacello (recommended) +### Via Metacello (recommended) 1. Make sure you have [ Metacello-Work](https://github.com/Metacello/metacello) installed. 2. In a new workspace load the project into your image by running: @@ -36,8 +36,8 @@ You should now be able to open AutoTDD by clicking on Test Auto RunnerAutoTDD.sar file from the project's [Releases](https://github.com/hpi-swa-teaching/AutoTDD/releases). -2. Drag and drop AutoTDD.sar into your image and select install SAR. +1. Download the latest `AutoTDD.sar` file from the project's [Releases](https://github.com/hpi-swa-teaching/AutoTDD/releases). +2. Drag and drop `AutoTDD.sar` into your image and select install SAR. ![Sar Popup](https://user-images.githubusercontent.com/38653851/126059197-f00de748-cbf6-466a-910d-bd5f8a4831bd.png) @@ -53,8 +53,6 @@ If you are upgrading from AutoTDD **v2** or **v3** please make sure to stop **al > GitHub Actions tokens require **repo** and **workflow** permissions. See the image below for a reference. - - ### What kind of tests is AutoTDD suited for? > AutoTDD runs user-specified tests as soon as any relevant classes / methods undergo changes. As such, your tests will run quite frequently. Due to this, it is not advised to use AutoTDD for obtrusive or long-winded tests. This especially includes GUI tests where windows are opened / closed frequently. @@ -62,11 +60,9 @@ If you are upgrading from AutoTDD **v2** or **v3** please make sure to stop **al ### How can I customize the test-runner? > AutoTDD supports customization for sounds as well as themes. To change what sounds AutoTDD uses, swap out the respective files in the `Resources/AutoTDD/sounds` directory and reload the sound player with: - -```smalltalk -ATDDSoundPlayer new generateSoundMethods -``` - +> ```smalltalk +> ATDDSoundPlayer new generateSoundMethods +> ``` > AutoTDD also supports various color schemes depending on the currently selected theme in your image. To change the look and feel of the GUI, select a new theme from `Extras → Themes & Colors` From f4db81343a94f2e54fb8045b0405947d11b7dcf2 Mon Sep 17 00:00:00 2001 From: Toalaah Date: Sun, 18 Jul 2021 20:09:03 +0200 Subject: [PATCH 9/9] remove obsolete sentence from readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cb807283..e6093bc0 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ If you are upgrading from AutoTDD **v2** or **v3** please make sure to stop **al ### What permissions are needed for GitHub Actions Tokens? -> GitHub Actions tokens require **repo** and **workflow** permissions. See the image below for a reference. +> GitHub Actions tokens require **repo** and **workflow** permissions. ### What kind of tests is AutoTDD suited for?