Adding some usage documentation. #72
Merged
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
akien-mga
reviewed
Feb 22, 2021
README.md
Outdated
|
|
||
| Run the command using: | ||
|
|
||
| ./build.sh 3.2 mono-6.12.0.114 2020-02 |
There was a problem hiding this comment.
The 2020-02 part is not necessary, there are two forms with either 2 or 4 arguments:
echo "Usage: $0 <godot branch> <mono version> [<mono branch> <mono commit hash>]"
echo
echo "Examples: $0 3.1 mono-5.18.1.3"
echo " $0 master mono-6.6.0.160 2019-08 bef1e6335812d32f8eab648c0228fc624b9f8357"
The form with two arguments relies on a mono/mono tag (here mono-6.12.0.114) so the branch name is not needed. The form with four arguments is to specify both the branch and the commit (and then the second argument is not a tag but just the name to put in the image version).
akien-mga
reviewed
Feb 22, 2021
README.md
Outdated
Comment on lines
129
to
138
| REPOSITORY TAG IMAGE ID CREATED SIZE | ||
| localhost/godot-ubuntu-64 3.2-mono-6.12.0.114 90aaecfcf17f 3 days ago 1.08 GB | ||
| localhost/godot-windows 3.2-mono-6.12.0.114 599caf446bd3 3 days Ago 4.42 GB | ||
| localhost/godot-mono-glue 3.2-mono-6.12.0.114 10542d0d9c58 3 days Ago 1.73 GB | ||
| localhost/godot-mono 3.2-mono-6.12.0.114 726d09a93466 3 days ago 1.51 GB | ||
| localhost/godot-export 3.2-mono-6.12.0.114 d61f79d1573d 3 days ago 1.09 GB | ||
| localhost/godot-fedora 3.2-mono-6.12.0.114 a71b68c67fea 3 days ago 690 MB | ||
| localhost/fedora 32 27a979020952 5 weeks ago 208 MB | ||
| docker.io/i386/ubuntu trusty 7d0c7adb414a 5 months ago 196 MB | ||
| docker.io/library/ubuntu trusty df043b4f0cf1 5 months ago 206 MB |
There was a problem hiding this comment.
Here's the full list without the superflous details and listed in build order:
REPOSITORY TAG SIZE
localhost/godot-fedora 3.2-mono-6.12.0.114 692 MB
localhost/godot-export 3.2-mono-6.12.0.114 1.09 GB
localhost/godot-mono 3.2-mono-6.12.0.114 1.51 GB
localhost/godot-mono-glue 3.2-mono-6.12.0.114 1.73 GB
localhost/godot-msvc 3.2-mono-6.12.0.114 11.5 GB
localhost/godot-windows 3.2-mono-6.12.0.114 4.42 GB
localhost/godot-ubuntu-64 3.2-mono-6.12.0.114 1.08 GB
localhost/godot-ubuntu-32 3.2-mono-6.12.0.114 1 GB
localhost/godot-javascript 3.2-mono-6.12.0.114 4.72 GB
localhost/godot-android 3.2-mono-6.12.0.114 19.7 GB
localhost/godot-osx 3.2-mono-6.12.0.114 2.84 GB
localhost/godot-ios 3.2-mono-6.12.0.114 4.53 GB
akien-mga
reviewed
Feb 22, 2021
build.sh
Outdated
| @@ -20,7 +20,7 @@ fi | |||
| if [ -z "$1" -o -z "$2" ]; then | |||
| echo "Usage: $0 <godot branch> <mono version> [<mono branch> <mono commit hash>]" | |||
| echo | |||
| echo "Examples: $0 3.1 mono-5.18.1.3" | |||
| echo "Examples: $0 3.2 mono-6.12.0.114 2020-02" | |||
There was a problem hiding this comment.
Suggested change
| echo "Examples: $0 3.2 mono-6.12.0.114 2020-02" | |
| echo "Examples: $0 3.2 mono-6.12.0.114" |
As mentioned above, the branch is not needed.
|
Left some comments, looks great! |
|
Updated as per your comments. Cheers! |
akien-mga
reviewed
Feb 22, 2021
README.md
Outdated
| In addition to this, generating containers will also require some host disk space (around 4.5GB) | ||
| for the downloaded Mono sources and dependencies. | ||
|
|
||
| (Note that this list does not show some containers: Android, HTML5, iOS, OSX and MSVC.) |
There was a problem hiding this comment.
This note is now outdated. :)
|
I should have reviewed the entire document better. Sorry for that. I don't see anything else now. |
|
Thanks! That's a great writeup. |
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.
No description provided.