Skip to content

Commit 7bc8bf3

Browse files
authored
Merge pull request #949 from prakashph/patch-1
Typo, sentence and formatting fixes for export_github.md
2 parents 3f2673b + 1510692 commit 7bc8bf3

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

md/4_export_embed/dev_embed/export_github/export_github.md

+27-27
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Select the "GITHUB" option in the export dialog:
66

77
## Prerequisites
88

9-
- an account on [github](https://github.com/)
10-
- any repository, create one [here](https://github.com/new) if needed (add at least one file, otherwise the repo doesnt exists for github)
11-
- an [access token](https://github.com/settings/tokens) for your github-user with at least "repo" permissions
12-
- if you use github's "fine grained permissions", make sure your token has "read and write" permission to the "contents" of your created repo
13-
- (if wanted) activate [github pages](https://pages.github.com/) for your repository in the repositories settings on github
14-
- your repository needs to be made public for this to be free
15-
- you need to pick a branch when activating pages, remember this for the settings below
9+
- An account on [github](https://github.com/)
10+
- Any repository, create one [here](https://github.com/new) if needed (add at least one file, otherwise the repo doesn't exist for github).
11+
- An [access token](https://github.com/settings/tokens) for your github-user with at least "repo" permissions.
12+
- If you use github's "fine grained permissions", make sure your token has "read and write" permission to the "contents" of your created repo.
13+
- (if needed) Activate [github pages](https://pages.github.com/) for your repository in the repositories settings on github.
14+
- Your repository needs to be made public for this to be free.
15+
- You need to pick a branch when activating pages, remember this for the settings below.
1616

1717
## Parameters
1818

@@ -46,37 +46,37 @@ Enter your generated [access token](https://github.com/settings/tokens) that has
4646
## Video Tutorial
4747
<iframe width="384" height="216" src="https://www.youtube.com/embed/1TwP5DQoef4" title="Github Pages Export - Byte Size" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
4848

49-
## WALKTHOUGH
50-
- enter the above information
51-
- click on button
52-
- wait for the two buttons to appear
53-
- click on "View Deployment" to visit your website on github
54-
- click on "Deploments overview" to see your repository on github
49+
## WALKTHROUGH
50+
- Enter the above information
51+
- Click on button
52+
- Wait for the two buttons to appear
53+
- Click on "View Deployment" to visit your website on github
54+
- Click on "Deploments overview" to see your repository on github
5555

5656
## CAVEATS
57-
- this will not work if there are any merge conflicts, do not change any cables files from outside cables
58-
- this will overwrite any patch that has been exported to the same repo/subdir-combination before
59-
- use git commit history to roll-back any mishaps
57+
- This will not work if there are any merge conflicts, so do not change any cables files from outside cables
58+
- This will overwrite any patch that has been exported to the same repo/subdir-combination before
59+
- Use git commit history to roll-back any mishaps
6060

6161
## Export Options
6262

63-
You can choose how the contents of your export should look, the defaults should be fine for almost everything.
63+
You can choose how the contents of your export should look. The defaults should be fine for almost everything.
6464

6565
### Include assets
6666

67-
If your patch uses uploaded files (textures, audio, data, ...) choose one of the following options to have
67+
If your patch uses uploaded files (textures, audio, data, ...), choose one of the following options to have
6868
these files included in the export.
6969

7070
**Use "All" if you are generating filenames on the fly (iterators, arrays, ...) to make sure all files are available in the Export**
7171

7272
- Automatic: Tries to guess which files are used in the patch and includes only used assets.
73-
- All: Includes all the assets uploaded to the patch or referenced in there, this is the safe option.
74-
- None: Does not include any assets in the export, smaller download but some things might not work in the export
73+
- All: Includes all the assets uploaded to the patch or referenced in there (safe option).
74+
- None: No assets included in the export with smaller download size but some things might not work in the export.
7575

7676
### Package
7777

78-
- Single Javascript File: packages and minifies everything into one single javascript file to include
79-
- Multiple Files: will keep the patch configuration, your code, and core code in seperate files
78+
- Single Javascript File: Packages and minifies everything into one single javascript file to include.
79+
- Multiple Files: Keeps the patch configuration, your code, and core code in separate files.
8080

8181
### Skip Backups
8282

@@ -85,18 +85,18 @@ these files included in the export.
8585
### Export without subdirectories
8686

8787
- Should you need the directory structure of your patch to be "flat" (no js/ or assets/ subdirectory) you can select this option.
88-
- This will ususally not be needed, some platforms do not allow for accessing subdirectories tough, and some setups of frameworks like react/vue also behave weirdly with subdirectories.
88+
- This will usually not be needed. Some platforms do not allow for accessing subdirectories though, and some setups of frameworks like react/vue also behave weirdly with subdirectories.
8989

9090
### Minify Code
9191

92-
- Deselecting this option will make your code bigger, but more readable, might be useful in debugging situations, you usually don't want this in "production".
92+
- Deselecting this option will make your code bigger, but more readable. While this might be useful in debugging situations, you usually don't want this in "production" (i.e. your finished code).
9393

9494
### Add Source Maps
9595

9696
- When minifying code, this option will add [source maps](https://developer.chrome.com/blog/sourcemaps) to your javascript files.
97-
This will make the code readable in dev-tools and may help in debugging situations, but will have and additional download for
98-
people opening the dev-tools of their browser.
97+
This will make the code readable in dev-tools and may help in debugging situations, but it will have an additional download for
98+
users opening the dev-tools of their browser.
9999

100100
## Minify GLSL
101101

102-
- Minify shadercode. Same as "Minify Code", but for GLSL-Shadercode
102+
- Minify shadercode. Same as "Minify Code", but for GLSL-Shadercode.

0 commit comments

Comments
 (0)