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.

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

[#53] Adding readme updates #70

Merged
merged 5 commits into from
May 17, 2024
Merged

Conversation

nathan-schmidt-viget
Copy link
Contributor

Summary

Updating the readme files for users:

  1. Developer working on the WP site starter files.
  2. Developer starting up a new client project using the WP site starter files.
  3. Developer setting up the client project on local dev.

The main README is for instance number 1. The README.dist is for instance number 2 and 3.

Issues

Testing Instructions

  1. Read through both readme and make sure what I added cover everything.

Screenshots

NA

@nathan-schmidt-viget
Copy link
Contributor Author

@bd-viget I think these edits should cover everything, but if there is something I missed from our conversation last week, let me know.

README.dist.md Outdated Show resolved Hide resolved
README.dist.md Outdated Show resolved Hide resolved
Copy link
Contributor

@bd-viget bd-viget left a comment

Choose a reason for hiding this comment

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

I like all the updates, nice work! Be sure to run composer create-project vigetlabs/wordpress-site-starter and make sure everything matches up with the README.md.

Then make sure the README.dist.md matches up with the process it might look like if a 2nd dev is coming along and setting up this project (maybe some references to clone this repo, etc).

README.dist.md Outdated Show resolved Hide resolved
README.dist.md Outdated Show resolved Hide resolved
README.dist.md Outdated Show resolved Hide resolved
README.dist.md Outdated Show resolved Hide resolved
README.dist.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved

```bash
ddev start
```
Copy link
Contributor Author

@nathan-schmidt-viget nathan-schmidt-viget May 16, 2024

Choose a reason for hiding this comment

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

This makes it easy to just press the copy button in Github.

@nathan-schmidt-viget nathan-schmidt-viget force-pushed the ns/53-readme-updates branch 3 times, most recently from af83ab7 to 0814d77 Compare May 17, 2024 13:45
Copy link
Contributor

@bd-viget bd-viget left a comment

Choose a reason for hiding this comment

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

Looks great!

@nathan-schmidt-viget nathan-schmidt-viget merged commit 1393a1c into main May 17, 2024
@nathan-schmidt-viget nathan-schmidt-viget deleted the ns/53-readme-updates branch May 17, 2024 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants