Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamwoodnz committed Aug 9, 2024
1 parent aaaf300 commit 43a1ee0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 15 deletions.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
]
},
"scripts": {
"build": "yarn workspace wporg-learn-2024 run build && yarn workspace wporg-learn-plugin run build",
"build": "yarn workspace wporg-locale-switcher build && yarn workspace wporg-learn-2024 build && yarn workspace wporg-learn-plugin build",
"create": "composer install && yarn setup:tools && yarn build && yarn run install:env",
"format:php": "composer run format",
"install:env": "./bin/index.sh",
Expand All @@ -31,6 +31,7 @@
"lint:js": "yarn workspaces run lint:js",
"lint:php": "composer run lint",
"setup:tools": "TEXTDOMAIN=wporg-learn composer exec update-configs",
"start:locale-switcher": "yarn workspace wporg-locale-switcher start",
"start:plugin": "yarn workspace wporg-learn-plugin start",
"start:theme": "yarn workspace wporg-learn-2024 start",
"wp-env": "wp-env"
Expand Down
26 changes: 12 additions & 14 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,19 @@ If you're interested in contributing to the site, but aren't sure where to start
- [SVN](https://subversion.apache.org/packages.html)
- [NVM](https://github.com/nvm-sh/nvm) or [N](https://github.com/tj/n) (optional)

## Setup 2020 version
1. `yarn`
2. `yarn run create:old`
3. Visit site at `localhost:8888`

## Setup 2024 version
## Setup
1. `yarn`
2. `yarn run create`
3. Visit site at `localhost:8888`
4. To watch for changes `yarn start:theme`

## Stopping Environment
run `yarn run wp-env stop`

yarn run wp-env stop`

## Removing Environment
run `yarn run wp-env destroy`

yarn run wp-env destroy`

## Admin

Expand All @@ -46,15 +43,15 @@ To build all projects, you can run:

To build one project at a time, run:

yarn workspace wporg-locale-switcher build
yarn workspace wporg-learn-2024 build
yarn workspace wporg-learn-theme build
yarn workspace wporg-learn-plugin build

If you want to watch for changes, run `start`. This can only be run in one project at a time:
If you want to watch for changes, run:

yarn workspace wporg-learn-2024 start
yarn workspace wporg-learn-theme start
yarn workspace wporg-learn-plugin start
yarn start:locale-switcher
yarn start:theme
yarn start:plugin

### Linting

Expand All @@ -72,9 +69,10 @@ To lint one language run one of:

To check an individual project before pushing to the repo, run one of:

yarn workspace wporg-locale-switcher lint:css
yarn workspace wporg-locale-switcher lint:js
yarn workspace wporg-learn-2024 lint:css
yarn workspace wporg-learn-2024 lint:js
yarn workspace wporg-learn-theme lint:css
yarn workspace wporg-learn-plugin lint:css
yarn workspace wporg-learn-plugin lint:js
composer run lint
Expand Down

0 comments on commit 43a1ee0

Please sign in to comment.