Skip to content

Commit 3b027eb

Browse files
committed
docs: add more Windows info and fix minor typos and such
1 parent 3c2a6ac commit 3b027eb

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@ Out of the box, this template provides a minimal WordPress theme with basic supp
88
- Support for SCSS with an ITCSS structure already in place
99
- Support for bundling JS with `esbuild` and testing JS with `vitest`
1010
- Support for [Twig][twig] templates using [Timber][timber]
11-
- Database import and export scripts to make syncing between environments simple and fast
11+
- Database/uploads import and export scripts to make syncing between environments simple and fast
1212
- Generator scripts to speed up the process of adding:
1313
- Page templates
1414
- Custom post types
1515
- Shortcodes
1616
- Custom taxonomies
1717
- Reusable patterns
18-
- Sample custom blocks which you can reference to create your own custom blocks
18+
- Custom blocks plugins
19+
- Custom blocks
1920
- Code style rules that are enforced by language-specific linters
2021
- GitHub Action workflows for code quality, release management, and deployment processes
2122

@@ -39,6 +40,8 @@ Out of the box, this template provides a minimal WordPress theme with basic supp
3940

4041
This project requires [Docker][docker] and [Node.js][node] for local development. For a better editing experience for PHP and Twig files, it's useful to have [PHP installed][php-install] on your system as well, but it isn't required.
4142

43+
If you're using Windows, it's best to use Git Bash (included when you install [Git](https://git-scm.com/downloads)) for command line operations for compatibility. If using [VS Code][vs-code], you can [set Git Bash as your default terminal](https://code.visualstudio.com/docs/sourcecontrol/intro-to-git#_git-bash-on-windows).
44+
4245
To run the project for the first time, do the following:
4346

4447
1. Duplicate `.env.example` and rename it `.env`, changing variables [as needed](#setting-local-environment-variables)
@@ -88,7 +91,7 @@ This project uses [npm scripts][npm-scripts] for most development tasks, and the
8891

8992
### Setting Local Environment Variables
9093

91-
For the local environment we are using a `.env` to define the username, passwords, and the database name used in the Docker container.
94+
For the local environment we are using a `.env` file to define the username, passwords, and the database name used in the Docker container.
9295

9396
- `MYSQL_USER` is the username WordPress will use to access the database
9497
- `MYSQL_PASSWORD` is the password for `MYSQL_USER`
@@ -181,11 +184,7 @@ You can export your `uploads` folder for another developer to import or to impor
181184

182185
This will happen automatically on import, but if you want to manually backup your `uploads` folder, you can run `npm run backup:uploads`. This functions nearly identically to the `export:uploads` script, except for using a different prefix and putting the zip file in `sync/uploads/backups`. As with `export:uploads`, you can specify a name for your backup if you want.
183186

184-
### Atom
185-
186-
If you use Atom, go to Preferences > Packages. Open the `language-php` Core Package settings. Go to the Tab Type setting and set the drop down option to `hard`.
187-
188-
#### VS Code
187+
### VS Code
189188

190189
If you use [VS Code][vs-code], you can create a `settings.json` file inside a `.vscode` directory at the root of the project to change how PHP or other languages are treated by the editor.
191190

@@ -200,7 +199,7 @@ If you use [VS Code][vs-code], you can create a `settings.json` file inside a `.
200199
}
201200
```
202201

203-
##### Helpful VS Code Extensions
202+
#### Helpful VS Code Extensions
204203

205204
We recommend these extensions to make working with PHP and Twig easier.
206205

@@ -236,7 +235,7 @@ Whenever a new version of WordPress is released, follow this process to update t
236235
1. Change `WP_VERSION` in `Dockerfile` to the latest version
237236
1. Submit a PR with the update
238237
1. If your hosting provider manages the WordPress version, update it through their mechanism for staging, test, and/or production enviroments
239-
1. If the update made breaking changes, create a bug card and _do not_ push any changes
238+
1. If the update made breaking changes, create a bug card/issue and _do not_ push any changes
240239

241240
### Permalink Settings
242241

@@ -575,7 +574,7 @@ This starter template includes a couple of options for deployment workflows, inc
575574

576575
### Docker deployment workflow
577576

578-
This repo includes a [GitHub workflow for building a docker image](./.github/workflows/deploy.docker.yml) that gets pushed GitHub's container registry. This image can be deployed to any hosting provider that supports docker containers.
577+
This repo includes a [GitHub workflow for building a docker image](./.github/workflows/deploy.docker.yml) that gets pushed to GitHub's container registry. This image can be deployed to any hosting provider that supports docker containers.
579578

580579
The image includes all core WordPress files for the version specified for `WP_VERSION` in the `Dockerfile`, as well as the theme and plugin files necessary for the site. The other element required for the site to run is the database, which is excluded, since each environment should have its own database that is specified by environment variables. This allows local developers to test against local data without interfering with production or staging environments.
581580

0 commit comments

Comments
 (0)