Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite README to be consistent with other repos #2108

Merged
merged 8 commits into from
May 19, 2021
Merged

Rewrite README to be consistent with other repos #2108

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
db15818
Remove screenshot
May 17, 2021
88cc810
Move visual regression tests guidance into own doc
May 17, 2021
dcf76e0
Combine guidance on Webchat into a single doc
May 17, 2021
91a70d4
Remove the dependencies section
May 17, 2021
7601953
Simplify / move component section under tech docs
May 17, 2021
62b3677
Standardise tech docs section
May 17, 2021
7c1903e
Remove faulty screenshot guidance
May 19, 2021
a79d31d
Remove reference to broken link
May 19, 2021
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
7 changes: 0 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,6 @@ Configuration for the navigation links shown on the B variant of the ContentPage
This is a Ruby on Rails application that fetches documents from
[content-store](https://github.com/alphagov/content-store) and displays them.

### Dependencies

- [content-store](https://github.com/alphagov/content-store) - provides documents
- [static](https://github.com/alphagov/static) - provides shared GOV.UK assets and templates.
- [phantomjs](http://phantomjs.org/) Used by poltergeist for integration testing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I imagine this phantomJS reference was out of date anyway - at least I hope so 🤞

- [ImageMagick](http://brewformulas.org/Imagemagick) Used by Wraith for visual regression testing

### Running the application

```
Expand Down
2 changes: 1 addition & 1 deletion docs/visual-regression-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Visual regression tests

Use [Wraith](http://bbc-news.github.io/wraith/) ("A responsive screenshot comparison tool") to generate a visual diff to compare rendering changes in this application.
Use [Wraith](http://bbc-news.github.io/wraith/) ("A responsive screenshot comparison tool") to generate a visual diff to compare rendering changes in this application. [ImageMagick](http://brewformulas.org/Imagemagick) is needed to run the visual regression tests locally.

## Compare with production

Expand Down