Merge pull request #76 from bcbi/DilumAluthge-patch-2

Add some clarifying comments to the examples in the README

Author: DilumAluthge

Project.toml

@@ -1,7 +1,7 @@
 name = "SimpleContainerGenerator"
 uuid = "b8d349fb-717b-4aac-a9b1-e1da4219c631"
 authors = ["Dilum Aluthge"]
-version = "1.0.0"
+version = "1.1.0"
 
 [deps]
 PackageCompiler = "9b87118b-4619-50d2-8e1e-99f35a4d4d9d"

README.md

@@ -29,7 +29,7 @@ mkpath("my_image_name")
 cd("my_image_name")
 
 pkgs = [
-    "Foo",
+    "Foo", # Replace Foo, Bar, Baz, etc. with the names of actual packages that you want to use
     "Bar",
     "Baz",
 ]
@@ -47,7 +47,7 @@ mkpath("my_image_name")
 cd("my_image_name")
 
 pkgs = [
-    (name = "Foo",),
+    (name = "Foo",), # Replace Foo, Bar, Baz, etc. with the names of actual packages that you want to use
     (name = "Bar",),
     (name = "Baz",),
 ]
@@ -65,8 +65,8 @@ mkpath("my_image_name")
 cd("my_image_name")
 
 pkgs = [
-    (name = "Foo", version = "1.2.3",),
-    (name = "Bar", version = "4.5.6",),
+    (name = "Foo", version = "1.2.3",), # Replace Foo, Bar, Baz, etc. with the names of actual packages that you want to use
+    (name = "Bar", version = "4.5.6",), # and replace the version numbers with actual version numbers for the packages
     (name = "Baz", version = "7.8.9",),
 ]
 
@@ -83,9 +83,9 @@ mkpath("my_image_name")
 cd("my_image_name")
 
 pkgs = [
-    (name = "Foo", version = "1.2.3",),
-    (name = "Bar", version = "4.5.6",),
-    (name = "Baz", rev     = "master",),
+    (name = "Foo", version = "1.2.3",), # Replace Foo, Bar, Baz, etc. with the names of actual packages that you want to use
+    (name = "Bar", version = "4.5.6",), # and replace the version numbers with actual version numbers for the packages
+    (name = "Baz", rev     = "master",), # and replace "master" with the name of the branch you want to use
 ]
 
 SimpleContainerGenerator.create_dockerfile(pkgs, pwd(); julia_version = v"1.4.0")