From 8ae987dec04fb5ecc15adcba1f9d62b40d0d3ec2 Mon Sep 17 00:00:00 2001 From: Andy Li Date: Thu, 22 Dec 2016 17:35:51 +0800 Subject: [PATCH] Added haxe images documentation. --- haxe/README-short.txt | 1 + haxe/content.md | 63 ++++++++++++++++++++++++++++++++++++++++++ haxe/github-repo | 1 + haxe/license.md | 1 + haxe/logo.png | Bin 0 -> 6968 bytes 5 files changed, 66 insertions(+) create mode 100644 haxe/README-short.txt create mode 100644 haxe/content.md create mode 100644 haxe/github-repo create mode 100644 haxe/license.md create mode 100644 haxe/logo.png diff --git a/haxe/README-short.txt b/haxe/README-short.txt new file mode 100644 index 000000000..5c706a079 --- /dev/null +++ b/haxe/README-short.txt @@ -0,0 +1 @@ +Haxe is a modern, high level, static typed programming language with multiple compilation targets. \ No newline at end of file diff --git a/haxe/content.md b/haxe/content.md new file mode 100644 index 000000000..7563ab319 --- /dev/null +++ b/haxe/content.md @@ -0,0 +1,63 @@ +# What is Haxe? + +[Haxe](https://haxe.org) is an open source toolkit based on a modern, high level, strictly typed programming language, a cross-compiler, a complete cross-platform standard library and ways to access each platform's native capabilities. + +The Haxe compiler can output a number of source and binary files. As of Haxe 3.4.0-rc.1, the Haxe compiler can target JavaScript, Java, C#, C++, Python, PHP, Flash SWF, ActionScript 3, Lua, and Neko. + +%%LOGO%% + +# About this image + +This image ships a minimal Haxe toolkit: + +- the `haxe` compiler with its standard library +- the `haxelib` library manager +- the `neko` virtual machine + +# How to use this image + +The most straightforward way to use this image is to use a Haxe container as both the build and runtime environment. In your `Dockerfile`, writing something along the lines of the following will compile and run your project: + +```dockerfile +FROM haxe:3.4 + +RUN mkdir -p /usr/src/app +WORKDIR /usr/src/app + +# install dependencies +COPY *.hxml /usr/src/app/ +RUN yes | haxelib install all + +# compile the project +COPY . /usr/src/app +RUN haxe build.hxml + +# run the output when the container starts +CMD ["neko", "Main.n"] +``` + +Then, build and run the Docker image: + +```console +$ docker build -t my-haxe-app . +$ docker run -it --rm --name my-running-app my-haxe-app +``` + +## Using the onbuild variants + +There are `onbuild` variants that include multiple `ONBUILD` triggers to perform all of the steps in the above Dockerfile, except there is no `CMD` instruction for running the compilation output. + +Rewriting the above Dockerfile with `haxe:3.4-onbuild`, we will get: + +```dockerfile +FROM haxe:3.4-onbuild + +# run the output when the container starts +CMD ["neko", "Main.n"] +``` + +The `onbuild` variants assume the main compilation hxml file is named `build.hxml`. To use another hxml file, set the `BUILD_HXML` build argument during build: + +```console +$ docker build -t my-haxe-app --build-arg BUILD_HXML=compile.hxml . +``` diff --git a/haxe/github-repo b/haxe/github-repo new file mode 100644 index 000000000..85fdba1dd --- /dev/null +++ b/haxe/github-repo @@ -0,0 +1 @@ +https://github.com/HaxeFoundation/docker-library-haxe diff --git a/haxe/license.md b/haxe/license.md new file mode 100644 index 000000000..35a79db8b --- /dev/null +++ b/haxe/license.md @@ -0,0 +1 @@ +View [license information](https://haxe.org/foundation/open-source.html) for the software contained in this image. diff --git a/haxe/logo.png b/haxe/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..9940db61d5def38e84da7bf398ace8226d28c893 GIT binary patch literal 6968 zcmd5>`9D-`*q1h0LRmtVv>I7TB4ms5*v*oREwa?uLdG&CDN-a#W8bojnKPIyV;?k< z2O-QT+eku&F@f1Z4&J`1nNru`mPk z@$o}=?=u1ic=xvwuWES@nFr>#9zcS89)x>@c=MTf1$lZa{S)Bf>kany@QMuX_BP<- zlO6lV%mf-SwlwMbLVi9{@zcV?>jA#A7_0B!EeRRN9y{SdOe*U^&?Xyz3 zP#N8BjPW58VF`yOFL9+uA|}FAxvsnBoHK!9?GGGosfWC`*)w>~zR;|=_Gdhz$9hRh z`S|PSF5{=zUiqV08%v`#?!NRaEv@ZslWmjdsQ%p18a*yL-?C4NRKz*2wv#-(aWX0ROoEuZWKO=TMij&9b54qNxzhexKDzg6k zAWXF^X9*b3zJO?+?~UPp8r$TeS{iqBIQ7dxYnT44BkLX@UwiwmrTCt~FZ*bTo)O1Z z9zFrZoIq%Kr)Eb7H44~|vy5QTxzX=h)>w+_og6VNpBVOl9M*94L3#pyRnmw%f3TP1 z{AU_p)Ss#8Qqk#La1GWY7G@tY#%3!-9p+cE78%#F8XdCxv4`&mBYwF9wrU@iD@HSq z7z-}|LHGn9Gr>!|aSCk4KJ3;rxEW6k7Xb6di-jPeeKsV;O55XrPdv^%p$rWztG`Oc7Nnz*+v)rEM*OYg%)ROl@jAx~puhRxqw$T?o$N|E4(> z{bYA}<9;CHnG#8EU#~G~=XT@WgPU8wQQ)ktUkTi447EOzMGvpMWPm04&kOcbE9bkA zzJ>D}@P|w6qlzCJ_nb?P+B_6<*lW}GdQ9v#@3 z(13Qe8lHT2Tty*t_r%yMPSsA1*ZVn)BT^_N*w8(2`^r~Qq9A1N9X|B0;0WJ91kMDZ zXTK3}ZgLAe18x0PK;%aVI!teUIEy4)Sj49^=5{0+!=MP|2<(wAHv*D;dA`qoIWGHw zWKqNm5mH9a}%0q!fCxbd^_lc`7{0>x!V|67xfPYdM-i2U{ zY)w(f8_%0SrBuIiYHgUga|uQt;!#|syL@*5bGg@Jbp`~0FAPhsfmJ@-QFU$&@97ez zNCZ5^cgDy;_TgLigE07D5aAp_Tmcc#=oMRn%#j|~-L0mBwH7C}PU z0#kFlK1UrSM3FeyNYBuu`J}=l3iTR58wc|rKaraDIZd$zM)REzH2ggLp+Rui)K0^T z-L(R{`U&%ZXVJy}Gx8GFI)vNVo~bcS@=$=%17NHT!f>kfZ6gp220a_K3WVvb}vBtSBM&+=)9y~0(q_9{Z!+mKsKrCzI_-dDwrT{ z4Jl_yRP^9C=>c|*aVlfA+@AEq^VlX~aFQVO;3uobqPy)qoPr`|IwEYjgJMy!N}|u9 zG22whB>#t7!)@vQjd7W=AcBqGFtg{Pl3V4jo8TZorC-Y|(mLo^HYTc@Bmj0j2!i1U zLHs74_Ld%dV`y1X9a{CI>t^kCQBxW)DLs$7?0A`+>RT0Ho!dJ$lRMt8TvE?S*&nB( z7ff2zB>k&IyZ0APgkH#rG8l>RW$XemF~=F*7$4-ai_Uew};8Qe$;6G1qB&<<%g%{Rw@XmuAz zoAjIhKbJ;%@%^%S(+ZxQ!+@kRlzdm6xlvxHd%Je)jG}*vo`uapfO#VthFZD6Y3@}xTKp!syi8IkvXaP6Di;Kk9%w;nKIh{^~=@90#>!C@-a4_dUv#X$qdPn`=tOC3b2?#5Lp6F^i^Q;<&&c zZ0WYU0Z?YEI?*Tha_WDEZOS?2th0ZWD~y4_=)upXQVn#*TUS4MJV@1$m*wa=>qs4Yw&R%Nc#Ey81$c}LlT z=6HlV_NA4sWQ_&{A@jwEk=buyE|~Nw-#@S4Igz%Tgxd${Ndb34Rx%TY=*?LLHRcmU zg22Il`L=#bz%VnyZ&R-P1@p;-Av*^c{_0=cs#4`TQ=+CX(9~z$> zt0!rL?#oLLXL2!Xo+hZ2U@5KK$FI=WdKuKA#@Xay1s-f^9+E)y#aY4Dl?ZjZxi;>e z*g5m9-#wGf;f|imDsu&M;%ar(0mmFST%Fn@RmRXkZD_yKG{(<_ECkC{&a~6p0p_eq z6wTq`&h@H489yxXSEz|35aMPDL+oStS#{4Ap2+91Y&dFQK$;@a;ZUKkO`wI#KA}3q^5i@~)~96EKbGi$_11vQ zW_QoiY4Dg(JZVc^{&h-*0Dm0&eYs`L@=Uro7jZ-|4#e`|D<%sAC&vdKTbp)pmZYhM6#a8f$Z6 z0qU(cepVHo^ER8`lSZJU`8`1I@7^BE3(x2!wEA|YHxiRF8|7TD=*YsvuC=;D#jwZf z$}%dY7HtlJ6Al2~9jCc9iYdyuW~vq4rCeU-Uyrgd#{dh3zm)5ERHmo%eeLp1Gh*M< z3NN9C5b-#b*UuT$ALG7t`|#KJX~Svy0Ju0L5>)=F^zz~w4bP=U2wbJYQx|93qrcFf z6&_8h|M(Dv?<|KikvhGbiwWBb6%V=*nnWx3;~xy4%0X*s+U#&^LOl zb(PWZ(a*{pMMPr8^LwC?+7ml>J+vE-1R``Fl4sT=I;{PI^W9>0NF&Q<(_POwj=8IJ z$O%A%KeNx~q#aE2Unr~7ibY&c-MYEE9`l+zo#j6)BNKmWyo)-LKBo6guvYmt4R8#_ ztBrpig`vIUaS^RIW^qi|=ac1_sU*_H53!n^_sw94)h}tui~)Yy9utu27}^hj6x&y- z(fr@`%Q&vsSY6bC>G!Y6*S$xMqXIO($|#rLW1q0T;FXicW-s@hwP%Wg<7+yvIONH` zTLl_C1Mm&-K)1nGLf82)tn0t1yoUCKhoKjVz zGo>5gld}5j*KOq8L}SS-dX!GQD0sto0~b*>swXmka&wQB%3Msg|KyP7xl^NtXO0(l zI&xWlE9{&J-{=7U#?^1{J3LWYA?;)lb8{SFlU@rrqtvSdKS$RfT2N+z?n7Qeuq3fE2*O@>cXG`b>RzTH-3FQexzryeRPTa@m4@AXLB zg9pIo&l>8{G>X6X`%1s#;Dx~ z9NmwPDvYW{DbyR}9e8`I7+;6(o+tvr+`>j0kC|~P(yhk|u4B~x$pq@zMIf5AgUJg% z_~C7K-DC#SCGHz{FE9Ib8^G{Y2Y|-M&^mn`Nn2PL;@b#8bBLPJTKjKg(E!u~`06(I zsMFN$NXba`2PPTI{M4k2E#Puu#ukx^xpAf9AMb?cmCSsyl9#|eZS|+Lm;m>Y7uTYP z>}JQn$@M7!TNDqC0GHv)=s z@4F$+#{$8r+44AOSrky->TeyN8k>Nh<0)p6Jsm#jOhupk2c=ONsOp?*p1Rdx^vAQh z%f-(mU&FWMcIqc<5tkl-`k+v@M;KPEgkfgo2>O(55$?vD`<0I<$khU_PKSNE2G*Zb z%*o{Xns}>hQd^HI%hbgixf@!5A_=@xx#>Uzd<%BhiIQzC>r0H*9L~!6v~Fd#%Ayel zKRph)nicNGC^V+A1z|l(FkSsC>wkviI>*3w@Rl&yKn+MO8+%zg@RUzUk9LNq(r%hl zBxaHI$F@mPh-vuI*c;J~<%OxCp+0ZjaLeVbr9w%fCW$qLv)!;B<#)~zR4mqHZC>2i zbOQ)%Kn6dg_`xlnv-6>-XzB&S>3mQsu%#UqHs!}blUs1C_sMcGLrL?dpYZ0AsUG%O zvUTJ(g)^BMdgtsnDokmXsd~Ehc-xKM>#)I}Q5|%3DsZVw)=Xm@<^FsCQpfhZ3>?4Q z1|enj^c5uGH{qWV{)k(Dj0I@CFn+SJ3HEkxlTdqC1uF%SOx9=A zUx`&zVR&=W9L^dcC=WYNxb#gecioNxN{;|yPC;zU30`7=lZf!wA#Q)gF#n6y2nUOr zjWX->=HAKSRs7?M)X&Mrf)>DsASoWSf#Vd3 zifkAL^!Ov0Il@A{iUrb?U~%{??#(bjF>&O}XXyol9wCjT1D#0;`|y(l_J76t2z@*& zVQlhe_}s_d$il?@i9D*+X|vSC)AE*MXyK=O);-3!a?Vz3;Dh^t%7h_(p}(wncP?^j zb=?_PB$(#;w!h(r5gdj$Csf>f_Z)B@_0ji7WfhU7t*(_ISmwHbD?Xf*`%2GZUqy~e zhNVF8vganjWgNsKF25%7VFAce)xQ9>h#xj@0vfNULpw2Op*L-~k87=&B9;#Ec&Q?5 zHHyvf452PVrNhl&*$*=BX@}Cl;4XHyK$rX1(Y8sO?hlWz)V!10bAFcoRQzz;CW+Wp zRi57Vp=IgpBg5f2x%}j;*qI$>zi3HP`jqlx==4%-%3^idH;M!=xxsITs!D$>H|>Zw z3+fbl823n`NDtDaD_OEx%Lc2#WlsQ7n(l@^+CRZzhIjCBP?yQB&p7L3vo9DP9U%y& zq<4SAyqBA#`a-HuSj;<#7?}y|&zBqCJ0fCM%4_bOR&{Vd$c7+7J$P(KN_Rg0B(;_- zUDO0UoYwW3lROh`)3^yO$7Gl^`y5F!J*alH(ctIzaL0`?qz+ycy_kt+Fg|d?MT`l~TESmKqfATH z%fPZF-YP2u1x%LaaK)qJ$Ea6 zAKT4hWwN}1b`$Tp`Rd&xX4o~(xvOG={-Z!Y>KzP%M9_;hw9+$ica z!If6MW2E3a&N5tJuGlIlDByVIr=SC;xo!S;{Y`ol+w@DqtG4?eT0X%U<9+Tg(q$FC zzRmF_V=QCwOxNMX7o;LopoZ;93#zxR*G`;9*?E|$N)7K?Jg2fO5Z;nCHd^S9kU zSgt#^Y;Ewi_3ay^i=>|E$91@U8BWmnK8rylJ!P$s(0>qq9G%`fhpa- zCm!#oX0Ulse&==7>*ScEvMQri2OgJZUd7;Va0Y=D|ib(6DH1gC;tPDcH02%i*zu!2Mv9~I<#rFD%m&tAZ;c^P*FkX88N z@UNcY^Bu88{2M>G>b@ylcGgk?m$@_|%3T~4GFoY7p_e`l_;amykvsU9+B~&_94{-h z`@{BC0lwoDzAgKW`)Is?-8egAbp}r7G-#b9VcJ};vP-!&upP1@*O4{ZZRD~=XK~kQ zOB1K&+Ae!?V!PR^M9%Gd^E1Wyd8`^Ibf6&5j<<`~V2nq~}|=q?I`Q zVGyKC*e)~yHxmai+SCkOvU2`*%wMI?mD(Q5e;toYiv!}Hs)qj8El&kN+P)D8HM72> zK$EcJ++Rf>k6`C=GZ4q}^@JR3OksrSo{7JWdJ78mf-2-WWtd_LO|-{c`aij`EStl* z8J5TMqmCAVp8_AJ88UVzJWEW*cirvA4%?AM90KBiw5NnpUw^f|?Nq;KypxJ4Za6n0 zV0(9UERCHH;)hz*Z5=N<{5k=korz^=isSNI-1iamIgO3HvyK0c2R6dpQ-?J91U*b! U3x$iL{#y8txvg2H>Fvk=10+YJ%>V!Z literal 0 HcmV?d00001