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
Simplified and Uniform Example Instructions #3113
Open
Jaffa-Cakes
wants to merge
31
commits into
yewstack:master
Choose a base branch
from
Jaffa-Cakes:command-uniformity-of-examples
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Simplified and Uniform Example Instructions #3113
Jaffa-Cakes
wants to merge
31
commits into
yewstack:master
from
Jaffa-Cakes:command-uniformity-of-examples
+240
−106
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
- Added `--open` flag - Removed unnecessary instructions on how to run with `release` profile
- Added `--open` flag - Removed unnecessary instructions on how to run with `release` profile
- Added `--open` flag - Removed unnecessary instructions on how to run with `release` profile
- Amended `release` profile instructions - Added `--open` flag
- Added `--open` flag - Amended `release` profile notice
- Added `--open` flag - Amended `release` profile notice
- Added `--open` flag - Amended `release` profile notice
- Simplified wording - Removed unnecessary notes - Changed commands so that they should be executed from the `examples/simple_ssr` directory like every other example
- Removed unnecessary notes - Changed commands so that they should be executed from the `examples/ssr_router` directory like every other example
- Simplified running instructions - Moved running instructions to the bottom of each `README.md`
- Added `release` profile notice - Added `--open` flag - Removed `--release` flag
Size Comparison
|
Benchmark - SSRYew Master
Pull Request
|
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.
Description
Amended the
README.mdof all examples to ensure they include:Amended
examples/README.mdto comply with exampleREADME.mdamendments.Checklist
Reasoning
When I was attempting to look through examples to begin using Yew it wasn't always clear how to run them. Some examples required you to run commands in the
examplesdirectory and others in their ownexamples/<example_name>directory.This PR attempts to make instructions on how to run examples clearer.