Skip to content

Commit 9256797

Browse files
Merge pull request #27 from NHSDigital/update-readme
Update readme with better instructions
2 parents 4eb7dc5 + 8c24258 commit 9256797

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ A place for services within screening to document their design decisions and res
44

55
## Installation and getting started
66

7-
Read our guide on how to [set up a design history](https://x-govuk.github.io/govuk-design-history/get-started/).
7+
1. Clone the repo to a folder on your computer
8+
2. In your terminal, `cd` to the folder
9+
3. Run `npm install` to install pre-requisites
10+
4. Run `npm run start` to build the design history site and serve it
11+
5. View the site locally at `localhost:8080`
812

913
## Adding a new service
1014

@@ -14,9 +18,24 @@ For new services in screening, [follow this guide to get yourself added](https:/
1418

1519
You have two choices for adding a post:
1620

17-
* Add it manually by creating a markdown file for the post and folder for images
21+
* [Add a post manually]('#add-a-post-manually')
1822
* [Use the post generation scripts](https://x-govuk.github.io/govuk-design-history/generate-a-page-of-screenshots/)
1923

24+
### Add a post manually
25+
26+
1. Draft your design history post - it's often easiest to do this in Sharepoint
27+
1. Create a new markdown file in `app/posts/[service-name]/YYYY/MM/[post-name].md`
28+
* It's often easier to duplicate an existing post as that will have the headers you need
29+
3. Edit the post with your content - make sure it has a title, subtitle, and date
30+
4. If you have images, add them to a folder in `app/images/[service-name]/YYYY/MM/[post-name]/`
31+
5. Make a PR with your changes and get it reviewed
32+
33+
## Deploying and publishing
34+
35+
Once you have a post you want to publish, make a PR on this repo with your suggested change.
36+
37+
Once it is merged the updated design history will automatically deploy with your post.
38+
2039
## Support
2140

2241
For issues relating to the NHS Screening design history, [contact Ed Horsford](https://github.com/edwardhorsford).

0 commit comments

Comments
 (0)