From 0074e9dac72a35e5058f356885121aa82572682f Mon Sep 17 00:00:00 2001 From: ruffsl Date: Mon, 11 May 2015 14:28:43 -0700 Subject: [PATCH] Adding docs for ROS repo --- ros/README-short.txt | 1 + ros/README.md | 67 +++++++++++++++++++++++++++++++++++++++++++ ros/content.md | 28 ++++++++++++++++++ ros/license.md | 3 ++ ros/logo.png | Bin 0 -> 7197 bytes update.sh | 1 + 6 files changed, 100 insertions(+) create mode 100644 ros/README-short.txt create mode 100644 ros/README.md create mode 100644 ros/content.md create mode 100644 ros/license.md create mode 100644 ros/logo.png diff --git a/ros/README-short.txt b/ros/README-short.txt new file mode 100644 index 00000000..942616cc --- /dev/null +++ b/ros/README-short.txt @@ -0,0 +1 @@ +The Robot Operating System (ROS) is an open source project for building robot applications. \ No newline at end of file diff --git a/ros/README.md b/ros/README.md new file mode 100644 index 00000000..bd59361d --- /dev/null +++ b/ros/README.md @@ -0,0 +1,67 @@ +# Supported tags and respective `Dockerfile` links + +- [`indigo-ros-core` (*ros/indigo/indigo-ros-core/Dockerfile*)](https://github.com/osrf/docker_images/blob/8a11109079636bcd3bdf341993d39e2b7d503c6c/ros/indigo/indigo-ros-core/Dockerfile) +- [`indigo-ros-base`, `latest` (*ros/indigo/indigo-ros-base/Dockerfile*)](https://github.com/osrf/docker_images/blob/8a11109079636bcd3bdf341993d39e2b7d503c6c/ros/indigo/indigo-ros-base/Dockerfile) +- [`indigo-robot` (*ros/indigo/indigo-robot/Dockerfile*)](https://github.com/osrf/docker_images/blob/8a11109079636bcd3bdf341993d39e2b7d503c6c/ros/indigo/indigo-robot/Dockerfile) +- [`indigo-perception` (*ros/indigo/indigo-perception/Dockerfile*)](https://github.com/osrf/docker_images/blob/8a11109079636bcd3bdf341993d39e2b7d503c6c/ros/indigo/indigo-perception/Dockerfile) + +For more information about this image and its history, please see the [relevant manifest file (`library/ros`)](https://github.com/docker-library/official-images/blob/master/library/ros) in the [`docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images). + +# What is [ROS](http://www.ros.org/)? + +The Robot Operating System (ROS) is a set of software libraries and tools that help you build robot applications. From drivers to state-of-the-art algorithms, and with powerful developer tools, ROS has what you need for your next robotics project. And it's all open source. + +> [wikipedia.org/wiki/Robot_Operating_System](https://en.wikipedia.org/wiki/Robot_Operating_System) + +[![logo](https://raw.githubusercontent.com/docker-library/docs/master/ros/logo.png)](http://www.ros.org/) + +# How to use this image + +## Create a `Dockerfile` in your ROS app project + + FROM ros:indigo + # place here your application's setup specifics + CMD [ "roslaunch", "my-ros-app my-ros-app.launch" ] + +You can then build and run the Docker image: + + docker build -t my-ros-app . + docker run -it --rm --name my-running-app my-ros-app + +# More Resources + +[ROS.org](http://www.ros.org/): Main ROS website +[Wiki](http://wiki.ros.org/): Find tutorials and learn more +[ROS Answers](http://answers.ros.org/questions/): Ask questions. Get answers +[Blog](http://www.ros.org/news/): Stay up-to-date +[OSRF](http://www.osrfoundation.org/): Open Source Robotics Foundation + +# License + +The core of ROS is licensed under the standard three-clause BSD license. This is a very permissive open license that allows for reuse in commercial and closed source products. You can find more about the BSD license from the Opensource.org [BSD 3-Clause](http://opensource.org/licenses/BSD-3-Clause) page and Wikipedia's [BSD Licenses](http://en.wikipedia.org/wiki/BSD_licenses) entry. + +While the core parts of ROS are licensed under the BSD license, other licenses are commonly used in the community packages, such as the [Apache 2.0](http://opensource.org/licenses/Apache-2.0) license, the [GPL](http://opensource.org/licenses/gpl-license) license, the [MIT](http://opensource.org/licenses/MIT) license, and even proprietary licenses. Each package in the ROS ecosystem is required to specify a license, so that it is easy for you to quickly identify if a package will meet your licensing needs. + +# Supported Docker versions + +This image is officially supported on Docker version 1.6.2. + +Support for older versions (down to 1.0) is provided on a best-effort basis. + +# User Feedback + +## Documentation + +Documentation for this image is stored in the [`ros/` directory](https://github.com/docker-library/docs/tree/master/ros) of the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request. + +## Issues + +If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/osrf/docker_images/issues). + +You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net). + +## Contributing + +You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can. + +Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/osrf/docker_images/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. diff --git a/ros/content.md b/ros/content.md new file mode 100644 index 00000000..0c2d1f43 --- /dev/null +++ b/ros/content.md @@ -0,0 +1,28 @@ +# What is [ROS](http://www.ros.org/)? + +The Robot Operating System (ROS) is a set of software libraries and tools that help you build robot applications. From drivers to state-of-the-art algorithms, and with powerful developer tools, ROS has what you need for your next robotics project. And it's all open source. + +> [wikipedia.org/wiki/Robot_Operating_System](https://en.wikipedia.org/wiki/Robot_Operating_System) + +[%%LOGO%%](http://www.ros.org/) + +# How to use this image + +## Create a `Dockerfile` in your ROS app project + + FROM ros:indigo + # place here your application's setup specifics + CMD [ "roslaunch", "my-ros-app my-ros-app.launch" ] + +You can then build and run the Docker image: + + docker build -t my-ros-app . + docker run -it --rm --name my-running-app my-ros-app + +# More Resources + +[ROS.org](http://www.ros.org/): Main ROS website +[Wiki](http://wiki.ros.org/): Find tutorials and learn more +[ROS Answers](http://answers.ros.org/questions/): Ask questions. Get answers +[Blog](http://www.ros.org/news/): Stay up-to-date +[OSRF](http://www.osrfoundation.org/): Open Source Robotics Foundation diff --git a/ros/license.md b/ros/license.md new file mode 100644 index 00000000..aa8b8712 --- /dev/null +++ b/ros/license.md @@ -0,0 +1,3 @@ +The core of ROS is licensed under the standard three-clause BSD license. This is a very permissive open license that allows for reuse in commercial and closed source products. You can find more about the BSD license from the Opensource.org [BSD 3-Clause](http://opensource.org/licenses/BSD-3-Clause) page and Wikipedia's [BSD Licenses](http://en.wikipedia.org/wiki/BSD_licenses) entry. + +While the core parts of ROS are licensed under the BSD license, other licenses are commonly used in the community packages, such as the [Apache 2.0](http://opensource.org/licenses/Apache-2.0) license, the [GPL](http://opensource.org/licenses/gpl-license) license, the [MIT](http://opensource.org/licenses/MIT) license, and even proprietary licenses. Each package in the ROS ecosystem is required to specify a license, so that it is easy for you to quickly identify if a package will meet your licensing needs. diff --git a/ros/logo.png b/ros/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..637cc37dede2ae075f19c886622096185399ab87 GIT binary patch literal 7197 zcmd5>g^7m*|}%#%(-{YIiJrtH%doKg`9+u1Ox(+tEnpM0q5^G2QeYg zqK(UQfzvHdMKyh5;1@t_`wqCi?XGI#2?F6`ZVtSl_v^AiCxh1$W3T6K_Fg{Luk1iR zK0ZQDFX5gx*6wyfZm%4&c4QerAf`+;WvD(PdpqY%CGB`dMcz0QQc*d%{U3IlV!jm= zUeRB7`_JYDl$?^8QuJkt>3AWJAyxe}btL==l23VUvrE;S#*I&ksd-B7JWNaHyZ@d$ z-<|Q5VA3hn^MiHs3xjTRsX&;1Co$`!|ExStI&W*#|Kzd%iK*Gd^C!?M|C95w!1KB$ zfAsht{*TFHS)XDcHJFR_!vl35q;|YzU%_on-}}gk+*1GixI2MVxf~=fsDlN1cQ}!A zBIq9bP}pp#4`SO~cSEX=N$e~qw+(T9M8_6bUoz*>sY?Dx?6hRmv@?(Hd*Vbyd>VdI za8&Txw5ncWXq~K@M5seT5n81i`A2p)Cg|Kzxjid+{U9w!D|;8B-i{w4%hqWN>yIBm zhRQy;Q$f;0A%((t{~9E+5-*q#r87U0*J3zXSTKBBN7b{H2uqC5j>R%nX55-1Y)tr| zfhcm7+kY-&`Tly9=zf$%6120?d+t!~x+a}kgQ_2_)x&BU2y#)W@3+3&9@Z$UmTh31&?=9_|@nI<2yt~F#4M9eslIRGFfVZ}Etd!eX z2N{B|wx{%PEVkm`4{^r?ioH!C8r6hMke&+l-1>&H>ZLmG=@PDs0Rs)~>ov!|0o4Y^ z_Q}RA{e2F_8K2(tT>rp>n1MeNc6ksFC-}LQKbJ3MDE~(Nv=DD+=9?TAnJ)pKoWuIF ztG7OUFsir0HfR1eD2m8a(=}~zn+PLfg4|cJ?{{s}jsC&H&MnRz8epdS=eVUwCU7|Y za<%W!w~vQ(eKzuUS!^_iwNZh-`O!sg?6t|ju>pha)6Hmc-Y$FCj4FYl;#a0z0gEP| zld!gzUZ0&9gQ?*%O#5N}rHo#*N>4j82!AjI(Nt0wvF+PgCNa8#2|6?GE6MHc10)bO z_}{VTH+|9-=|{GH@JXS)*Q>S^!5+Za5~A&2pD@-Nw4Hg=SL}*HWn~yL)%LSDIV0P} ziw<@x*>-d(%GMI0)v?6!&C5NDGtO>oE-*hhA~Jr)UNe}6DQT9aFY+8=9HvP*)pkFA zlZpGYI_F~J8;@`HqtbjHJwaBl?5)Sv925d@pQ-<sO0t4ET&p&So;@;zEUGaTYZ0rnT0&fnc(}7X0jcK1dv!v*; z&@HP+=t9c&Gzw-$|1>9t4q?};UQenEbL^+$8ppTEFAn;p`h*zI+SLeo{ld?C)M4EBc z%bXI2@2*AcFeg{l>hRR+eU9bX7qg9ztqw13&T_9! zHRaOcL~rfc1zDai7aJVjD>^NAB2TGQE9}iV{o=$zTd(hrM~{dxcoB6+%7j;)-|Nit zD=DZBtHp@8O-g+spptw^(Gg*pm)F2LcIA zWfFL9IN!al&g`QDDn+TOgJU=PP*aSrpl7hk zQu~nGHxbHP12e2}Y+SMnvmf27esmj~)##{8y1}x)0%gn%2h<=nXBf?VwkjZVw?xQv zY_aAhidNdr8jKSUGDv3Fum@IOGBS<};LrzD#!aa&>6QEPwB(2Qb0i-FX2bYEbNcT- z!e*q%vDL<2r+P4@rh2tQSK1>Wl&2+CsW^NLyGNIM7FE@#t2gZRt^cEaPT5lN;zabJ zDTVLd^nJp_{$-u__k1nHKP*}t?PXPzzJ(6xsYm_xe!d4+)XT&sOEgPb`YV#mJwo%4 z>cMKclh;pcV8+#Z*>=h#bJ0sRJhC8d@ifG!Us3Wi?`CYX{isx*dWEH&?)U1aO5ox;Q&-{?QVc&lk7QT3NPyI=upSM`YEVr1gZQVM_`(n>j zhV9#w^WP`;avBX^inwE=zlgIAB)OAfHnLeBq6?*e6ZPJmVsGp{dtI1`ddjFRuAqiQ z8K(?Ewnm&)c2F>Xx7CoVpN{Q>&z(_E_4radpN>8PH7*iaf*VFL$lmWc>SeysTvb)P z#WaM7f+2Rb)rfBi7rpQDQFpR}>UjLxG0~Q??RC0ucwL@2#~S9p;@J|yfADu4`i^5cgf37 zb>ZR|mziYPsjh1(xDb1xZxCX8J;FMK$eDlTwf*yyXx$?Qctiqg-M?3((!Cy-Z)S0} zZB8uUgxv_5qH(3`YtFE(>7#k5c4~Ren$ezxHVvfpa4aq^9rB3zT)NP|2#dJ0V)+p^ z+B&#q3HbL?QAuDx=iTt|U>1T}E;%5!o0WS!|LMbbyc4)P@nfmGo4-u;PR~Sc-1Q~x zs3M<7@$XI5Twyf0N5nzB^`+@ku74$*R^aI38r3+aNcg1amWB%ODhl3*zGlyrzq@fZ z74ncfmu5;Lkx`I8{EZ{UcQ~6lO`9t^J#4p?b`=t5N0NyDl9OdBpX9I8?;J!6P8Jhw zYd{~zdvfjgBm|&M`i0|7teUL@_LPT|u;WsZfz1z5c0HcjSG(?m9xCtUB`)rT=HWZ6 z&_0j-7?qOZH>4ln>TNYsWujUhoIS@AzjgA!9QS?&gxKj}W1W*Y5pkt{1(#=ED1YNA zKYAnZ=GuE;p1Krv4&`Y0klC$i;M0&J9<(eKz8EFrZMW0d_Lz4eooXfsSZ=oiurK5S zx67vsAjd-ipZXzue0 zX~y}-q4ZyYRj6T$l6#$r)b9pvOvWX9m7X^SBFM)q>1FyZd2_>168a;S3jUAeX4u+7 zB%AnEyqTN*8;`$MkT^PAn7L`&na#ei?k;X?_GiL6U&>GRmeYf&e@Y&tmHL&5r6kLO zUcsw4#iuX$Vl4~9mSO)SNuG74Eu4hydMO;`ugeb&;?EUaBfP=?aC;oSmV1FLy$oS{O9vu7 z%Io{I6FmmrBCN%qPL%XR+v7cpV0$a55G-x!T6)W<0}5l>Nbgc(J`#Oe@a7aMN#Ok% zg6~;?8Z_sccN*K9%Iq8oFV7NyQYsfng)6B*AWxwPkzKam4isLW zuZOF$NOG3se#0qrRu4tanAuXTD*%-P84(ncO;=N>6|Q-=L`i8E9i{QLyN5439^p7W zyyC3M4Hk$N5c3k)a6-Fgf`0YIwd<7g%FoaXc4n|FLBHeYS`>oWQDd=`!!>X-ob7E8 zk!-}@o(byRliFV||3cRaBFZbo(FBvE0US|!xlleGO9tt0( z&fCLY1o}Pl5T*iTRB}qKI1G{o=Nv13=fx@|NvUVhuqrGMdgwmA(M)S+o5S|j=2;9q zR^rn&nXjA_QPBvA*A6ZNryDX3E}WWRBG5DZeLNrgbu=-HOBq`ibp7>h^ zB*ZjuR)Bs2<%x4PRY@@~l^gLP5Do;13@ct5-E~lG+ZwaiQ+hguu}?Brv!Ua_WrYvB z#S;*QkA*t5HwfuBDUuov$7cWhOIt>&r zIV?L;tNb~dd%+^g$0hThYK0BU_n)Jn95pc0iW~Z7TD^X1;!Ar*{-q;7-t-~*g7n&OXXP3Q05#Yv;B+*Fp!O(sdE*wvU@-t$$B zl6i4^cy(fkGdESb>J4+MwML~;zqz)fpnt+-omDjrT}BuRNz|qX&mW-0VE_joDe=sQ z?ht7X3hFCKpaed7c#(#lYi^c?o(njqRo*_2^p{um#iNJCb0Qn77M9%`0v%))Ne~C`^i>gx7$s6a8)Lequ=<*n zZ-N^^kS=5HMpdd)E+18ReM?BGrmQ#V88$nl!*w9^G4wh&AWw~=&@WUpR?2TgDp%?1 zz)TyIw(c2VY<_o$a3K?6U&5P(py;d#8H|8~b8?DZz;ZM|j4#N3EOU^iZO_v?Ff?Ip zW%$92D&Vfcmfy#tfL|(T#A$1IQm}W&O>}Qc{p&qBTU{!XWMR@~oCNjT3){ulkLnJ` zF6;Z8kAt_Kq94wtc8+58wPiS|1|u#90vfvIQYiN(M1fyf}DdO3JKKRR~A!jYcCaC4^LjE zzju~01R=o{qrVOoP4u59jjcqnIRF3=>14q4?}x zCh;5ZdW!L&)|9PSKL22?d0p5j&jKIt!9-yUz4UZrl`#`KISs4;O0AoU+KRseFtL!) zH?Sc!*zN&dRtUf~&TMjyoyZ%N+}}CZOMUvfGX5jhnT*k3^i$1G0N4KsIl}5~oMd0n zqe51%1gua~fGW9R8;=|Dy*KsUka#EHO?ja@YCu1NfVl3O&^gKg{-{DLQOE0s4{ma9 zU_-nTadzc9lffIs7xrRSrM22;F7vDUzr0>?ZV^F%S*TM~F^00{*WW#Tt;O+2k*kG+ z66Fh^fP-$`OzaLn<%Y>JzZ$cgnNvqJ;a-?K?=C3Tb1cvkXe@yaQ}J2CE$+;z{ODW}MMEvVw`#`}605y%{{I+zKQN`GM<13lpA5 znR^%P*|#ntE(Su7f0@t)PQy}HTz@mcV^S?@c}pFSwrD#kzrLRTMoyI)es9-jz?}RS1AAkYCxmig(`6wsNkJ`YL&0a zVY8lN&KJG-j(MlPmVHHYumU;_dAzE<$QcH(IR?brt);`*MNL>4>p~^9Jh7YNfXC!l zZ_}idHS?ET*VCv4M?BV%)hqU13+N7b(6#=fi}`!Tt7;11JtRQcg~jf)9A|&OE@8;g z05bR_=cXQXqXXlqvt{(7FY4OtKf7}#J!@E0N!7Cq)|ks5p>60}QF6oIhWWqCNk#Yc zek%QG03U`AL$YuQUtgd{xN%9>rH&9n-~6E)<0CguXv%gG7~k}CSrAf4ha`k5IAQQ} znu>t(%RI?80c@An_Q{p$qoo2!1;aPWue{g*09s(JIA?I5Bhn|{@bIbw4A>LR*#4$H ztiTB`Q+yQv5iG{g?3Gaze+|#s%nV7ky_Pn&(C{C^^kS1la){%&RGD2*<83V^-w#9V z-ITDW?>CMBCJifBBWK7c6U+L@J5*&E)-V3xBSdqvg+?awbz~ty(N9jGAd&JDpaI3E z^AWx+{|B~q)WNGn3lHX9I$nHvaR$r!KMqiR$zks% zYWpP?N`q?DPm-ns$Xm&A4(-Z{2Zvoh|y$DfC!BQ};{2d24hVC{5>a4^sJ3JEoP zFQK;3UNpHX%&DO@!|oSYZPAg*-M`Slpr_ZFF(+NQ4r)d=IefTE3#-~j|Mb!_%ET2k zSmYh>2yeyc0f`A|WtDXz%H~ZGAx~|5=SWlOzO)-d@*ZTkxW+hc5WVi4!F1GMnK~wM zJ4w4IG z<9Of*-6eE)rB-PhqX17nXXAb~(9UCWKO_dYB1FP@5zENYFMmtN^@R@*#jhkwzP4iCb|2P*t-isJgL_QpA!3*DdZ9gD8$a2N27v76WU$z)JyNA zz8u4ELn}A{W50B^mY+gTrSzTp2(W)k6J>28Twc?NWgPQ4uOHz!k(PtcO9TOSi!QYh zXYxko49r8hqZ*gDo>~aj;>q|KE#rFMk?R2=(M-oXo*NVyECIx4-4g}2`xor8VONXJ xvw){K=*4ZXg+{J^=w)aDH