Chore/update readme #115
Merged
Chore/update readme #115
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alisonhall
requested changes
Jun 5, 2024
README.md
Outdated
Comment on lines
31
to
52
| - Install options: | ||
| - ```bash | ||
| brew install java | ||
| ``` | ||
| - ```bash | ||
| brew install openjdk | ||
| ``` | ||
| - Additional tasks | ||
|
|
||
| - ```bash | ||
| java -version | ||
| ``` | ||
|
|
||
| If you get "Unable to locate a Java Runtime", proceed to next step. | ||
|
|
||
| - Ensure your symlink is correctly mapped (these instructions will also appear after you brew install java) | ||
|
|
||
| - ```bash | ||
| sudo ln -sfn /opt/homebrew/opt/openjdk/libexec/openjdk.jdk \ | ||
| /Library/Java/JavaVirtualMachines/openjdk.jdk | ||
| ``` | ||
|
|
There was a problem hiding this comment.
All of these instructions are only for homebrew, right? Similar to the other install options sections in the Readme, can you put this under a 'Install options:' bullet point and then a 'Install using homebrew:' bullet point? We should probably provide other install options, such as a link for install instructions/options, so that people know they don't have to use homebrew.
README.md
Outdated
| @@ -59,6 +81,8 @@ A place to learn and share with developers what makes web work accessible. This | |||
|
|
|||
| > See the [Chromedriver issues](#chromedriver-issues) section if you encounter an error related to Chromedriver. | |||
|
|
|||
| > Make sure your server is running in another terminal before running `npm run test`. | |||
There was a problem hiding this comment.
While this instruction is mentioned in the testing section, I agree it's a good idea to include it here too. Can we just modify this slightly to specify it's the 'local' server that needs to be running?
alisonhall
approved these changes
Jun 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates instructions for installing JAVA