From c821cdefa435cc1cc839bea76a350dcacbce5897 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Fri, 7 Nov 2014 22:14:44 +0200 Subject: [PATCH] Add logo, improve texts --- README.rst | 39 ++++++++++++++++--------------- docs/_static/platformio-logo.png | Bin 0 -> 10651 bytes docs/index.rst | 15 ++++++------ docs/librarymanager/config.rst | 21 ++++++++--------- docs/librarymanager/index.rst | 2 +- docs/quickstart.rst | 4 ++++ 6 files changed, 43 insertions(+), 38 deletions(-) create mode 100644 docs/_static/platformio-logo.png diff --git a/README.rst b/README.rst index c4716782..6c4abe0f 100644 --- a/README.rst +++ b/README.rst @@ -17,21 +17,23 @@ PlatformIO :target: https://pypi.python.org/pypi/platformio/ :alt: License -`Website `_ | +`Website + Library Search `_ | `Documentation `_ | `Project Examples `_ | -`Bugs/Questions `_ | `Blog `_ | `Twitter `_ -**PlatformIO** is a cross-platform code builder and library manager for -*Arduino, MSP430, ARM*. +.. image:: https://raw.githubusercontent.com/ivankravets/platformio/develop/docs/_static/platformio-logo.png + :target: http://platformio.ikravets.com -* `Website + Library Search `_ -* `Quickstart `_ -* `Installation `_ -* `Project Configuration File `_ -* `Platforms & Embedded Boards `_ +`PlatformIO `_ is a cross-platform code builder +and the missing library manager. + +* `Get Started `_ +* `Web 2.0 Library Search `_ +* `Development Platforms `_ +* `Embedded Boards `_ +* `Library Manager `_ * `User Guide `_ * `IDE Integration `_ * `Release History `_ @@ -50,7 +52,7 @@ options: platform type, firmware uploading settings, pre-built framework and many more. .. image:: examples/platformio-examples.png - :target: https://github.com/ivankravets/platformio/raw/develop/examples/platformio-examples.png + :target: https://raw.githubusercontent.com/ivankravets/platformio/develop/examples/platformio-examples.png :alt: Examples :width: 730px @@ -59,19 +61,18 @@ and many more. * Automatically analyse dependency * Reliably detect build changes * Build framework or library source code to static library -* Build *ELF* (executable and linkable firmware) -* Convert *ELF* to *HEX* or *BIN* file -* Extract *EEPROM* data * Upload firmware to your device +* Lookup for external libraries which are installed via + `Library Manager `_ It has support for many popular embedded platforms like these: -* ``atmelavr`` `Atmel AVR `_ - (including `Arduino `_ based boards) -* ``timsp430`` `TI MSP430 `_ - (including `MSP430 LaunchPads `_) -* ``titiva`` `TI TIVA C `_ - (including `TIVA C Series LaunchPads `_) +* ``atmelavr`` `Atmel AVR `_ + (including Arduino-based boards) +* ``timsp430`` `TI MSP430 `_ + (including MSP430 LaunchPads) +* ``titiva`` `TI TIVA C `_ + (including TIVA C Series LaunchPads) Licence diff --git a/docs/_static/platformio-logo.png b/docs/_static/platformio-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..62bde5cafc90baa676f01b25cb1fd2a79dfb859f GIT binary patch literal 10651 zcmeAS@N?(olHy`uVBq!ia0y~yU|7n)z_5seje&tdL60|yfq{Xuz$3Dlfq`2Xgc%uT z&5>YW;PTIOb`A*0$S=t+&d4uN@N{-oC@9KL%gjk-V5qn?H#j{c_@$Wb_j_NQygM4E zc;^R+awr5jbvKAiRMS%A6!7X$TzFG7@SvcpD~t4r1s%+NeGNULfjT^0TsPRCC@$)2 zUfj`j>i5Iy#o5>Pe1CTK-`4AP&)0mOyZJo(0S=yN9>#&D4LmEI8^l^Gd+)Y;f*D;;3p$G})|nVW;*fbZ-B1~Tpc`CmEBjA3kOVLVVW z(ZZXfL4?7fs?TW|gM%Am!`vBa!3+yn7!pn=Cp~5e&}B$auYY!#p<(WinbnL8(Nh#f z85c}sP!LY-aAC->W>|ARtjm=l!hk^}&HIQY!wp>q1JCd@4~7lf84jEi;NHZ*!NXt> z*wL!Vz*5bSa6(zRf}v$5gNWOwaGQ_X>ja)_F)&oj++?#;#nQDgnnSmcJv>}bPUD=X zxVDH{B2(fl2fag;GbN20P52*tKEuGUV4|qtgXYhFE6(w)J9o~kZyR5{?yLQ5|CN%G z9{+oKeszHZ1H;3Tx{LpG^fya2ShF?c{#&H_jwK_GdqL^z#w#e-g}EoK%h+auRUj zN@d<#}gdF ziHf&67?Zjpl>0cuXSV)OJm|q9)UBd$vO^?L$$O%yhhb1xh(f4`>?hkICd>91w_Ovh zPcRrY{b}3dZaAfJQ=sh?o~_P1SC~t+xGmzokWyket6yxv>5WQjcvc^i+7Pyed3Wd6i_@Hwxh3$By3*to-dogm3I04Hkz{1p9^s**d`+ld zSYM#J!}*B0icqJsk^0UFOr9H;gj^E3yx=p4nHw|BK<`1Q#9AyB!|K!KY|}=1f9zAl6)%g)Z{5!>I@^t(8aTY?yguEB52wl z<+OI;wxIQa?JI;$N@rP~Z5H$NUb=SC)XP#C;u+sF*S{#)C3ttLoZs{d;g?Robbm4Z z1@o739^N+5=Hngd8j`am*d@{>%O%#&@L48#xm)shh=IA`>lx2y^3Ti>SC5BnVUcU}^>U}OB_J;xNdlO;D-=qP6Mu5K%BG(DoW@$Ai- zGOgV+{>tv|wq3Pyp{292mvQ*!pwCm%?AagBDEu*}#E$>iVyw`lBDZR|Z zXQyFmO!lg2)2BtO_E;Ub+WqxjvvqHm&t10Hb$8_NMn1>mUg|OG?&-1J-FO^=n+ogPe-tu=d=Ix7XnCFwf{9fhW=f7lX_5X(a&Hc6ft2<8w z+h!gWw%a`CBy5hF7UtW?>L0)TG0-{ou!Hl`#HoqXAGS=~dC_L^RkvO@{+`TZF^^Rq z=N`*Fwpfi#O;OF;_m%IvSwX%#muW7u_ObRke)i1SMQ5+gG@Wg0c-`pv?B}zu&%VDs zA*v!uXWNQxJ5oJ2J&9Tt`EJ{uyw)ho$fXgXQL&rd*3Mn4dTsaG-OB}+@ARAOw|d^S z^urrIZacYc<#x#pPj9f@UbiiGTWw-`l6d;|qw5a8o4j{&?XKG1zqahW?Kk;W%SOr8 z6>ljLu?n-gH|yM-clNbMzf60npB`~u;QS5a$J>NYYaYp*8$A26d%Ae~&f@0J9o?PY zO{evy+v&}gK6dxS-X~rqUkhU&R$cl!clPGlhu*HZz5boqyUcg(cjlilnXfr7(zy7- z;SSmx-;3LQvn!ha*zU27 z`8}h1k@08D4{SfN{j~q#{CV-M_nqsN|EK(~`hSsOd4norI&){EV`DVa?;lk)iu?QQ zt!}4&+jR4-W6y$}j-rnJO>3K;9$c%KapKK{wTj=L&p0>nTqa*@K;4UL7uXY@C3YXK z<56#IZw+s=?2hUf0W1%Wjokmd!2mT_(Hi zkLjgFp1B$^H^MW=TgFmPYn@qM&c6G9-hOU>H1`qr<7)94`X^!wDi@wR^rdyV*h)Pi z9jj>$J{^7*Q$9EfXsrIbBr|m!6dCGFy>Ur8{-=5ig z>h=WlIq&EHe=BrI=;5SoOWVA|b!8)-?Ol^)xyh!m@;29FQC97?Ft#-|JG!=MuGE4>pR!q#`;I-N8aC>_^WNMw4G>Y*E*5g z;?qUzZ)n`9cq-kVe`^2CJ5#o-TzzC`%K5ZQX)mAM)14R1H*MAQXVdxecyHd?!h1h# z%iFKtTyN`7KdW(jck?#qos0L|?AVjK{N%Z_*7hMwLcWCj3Nd?k>F(CV>p$`?zLT!r z^UdVV)!Wf~zW=p5x$kx;W2o=dw5zGVJ%4ZhZojT`)yp5#e&@!n^~)`Mdz|?a^Ivvl zzHQfcUb!lJ$u=aY|C;t|cfRBD`~J;+U#`n*#v9r@=h!3V0+-4sFTZo%|1QUCb*rqW zdd)-j%kpKi>9YD+PP0DEa+@7I>vwcg^e+E1b{DU`x>xnb{kA;+921+!O0Ul$Co^xo zY`Q!-{nPoLxl`xX*6IDclW=>{w(94}=k90m=fB@2Q1bAS>;LZO)_bha#eCXP@@doU zr^4Yo!e_0wiqCyj^2+AlO4!^yL&%Z<$pi={p)?PyLCnCf6txXeY0Hs-P%3=d*Z)1ymh?ke7F6oee}OOH{Rc= z&pJ@P;Pb^h?%&y3o6rB7__d$knYDjr|LHc~w%7A4>?|!G*%$qN`DeNF`IPf&^Thux z`geMrxR`$3kE^e*pSw8Y;=<{lrcd6VTeI}abLoIzdcxf zr(E{^;`{vmPihqEHU4M(-1s&4!t&pfB_~h*&%!+8^Pgm6-P@pMXR=3-F9SoBDg#49 zGXulV{|pQbFBuq04Hy_+B``2p&0t^<&z}^3)Qy2b?wF^GV@SoVH?fr!Ay@C#y`Ov1 zNyy1*Qlii%0R`(sPJtB8ML|oo!j_n6F)dR1c6nR;)oZJ^>ej6-b>!ZfCCC_Q%ETDR zqUhkEz%6iMpT6}Z-z?o`7+-ynt5!{7if~&!DXF6%Qfq2h?#)f9%QsqZ2JV~p>(%MNz`%(iJtEUY z(o<4WuKX^x|K(ra*ijkd!s=-_=fk;Er;6@8+I90^m&r#hh7ET$t4%m2J+C~Ko0Ak7 z5)$$x?&`X!wi7q~x_s(;baZrhZ^<*B!vT587D>;ZKD{~hZfIf4-PO0YZaRG>Ab>}E z)v8rXszY~&b;ZQSnopZDWzF(XCqtn{OFdL3b>`&e#%JZ`@-F-8Xee~y;>EzjT2s9^ z*K&1DWLg@enfP+DRM$k7zQ++-9$kX$T3%dQUR)rIpt|lEL`)7^p`ppf+ia@Y+BKO3trA{N_rr0S?h)RAMpq8I&GqM^92V5>6GW{F?@bs z=y3jMw5Z3))sn`wF;IenVmTM%Q)!f1OmWP`q+4AfQ~% z_)xrrac#`3eZQN3y`Q+~f}m^n^}kZ*&YdeLE0eqR@7j~I5xOEO4Uf3*e~r0)^I+AL z@bxEd-uxNKa4#gYyvTa{!W(It^Ww~|Du^v#`5|*%^WJ=hm|NTdLF*+ad9SZ}9P4tf zOmNB-rFXx5d}awYG&C@<{IF2ajkcSW9qy={Y9ILFW!;mkR@J_Ug8A|c2b48RGTyQ3 zF-+wDC77C3sTE|+d%X7()2n^QwJTQ33)b$Orcpd|t3(i6!rWSe@<#$ZUiKf1#Dw=U z%NnhV5tZ4#NMUVLSCLKfd-e1x9s`C0Syp1~w;A{7rnUTRdj8X~HtExDU2l){Tl4z0 zS=;iOwryjv%v$z*m(BU+<%?v}FMfKKz9Yg>YTkjR+>8w0<~bHz&02UhYoRntYDdWI zkKL7iE|EvirkH$@DbzT7mSy>6hufvGf9+*OpY9M+4en)jH|jLX{%$!V|2(sj`5CTR zE2ek%Nq^Wn?ce<@W%FANs|$^o#YzbK$|3#UIi%EzZ4=(&@fv(c98hB(ULg zH+KLhch27pht5ki$o_fm`Im+L$*+*9O*^>sbVtG80M*+&`BoqHY+ih3M^n|o!pbl;i^u0wA~q~8 z*>-n@$WxEmGfpj*+TE8jvF&)V; z^m*ByLeVqsFtZ&YH&Uic|XIPjU^Hjc@R9kFRi(|o5t+}SL1PUpAnJ2Nwj@E#t& zs+F0q(%kZ=Y+0ev8~iRJ=JTf7^RAaZ_;IL%&b$9%&yJ^YmmXwv zO`LJ{Uh#_DNs60W%}p&9U6jq%Id;$DY2Q&({XhQk3XLmGe$ZD8{`F1lUv zNb@_fnEe4M7FV<;PQGuojE7J3sldZex77nZr|eLuIT>OgaM1clLd7qhX@5l4)YpjJ zOkeBcJSpLudv+w>s3i7vFsl5XiT5rS(U76*CFRdApy#2zTG<&6f|pJ~r>*!bLJ(;^&?`oGt&ka}%fCLynD%39tJE;{QI< z3x3Y?WA7fp#+HMb$F^D=7GjTE?ULp=+w)iYjf?pOD>T|A(zm-WK6K)PPShL5hSu|M z^n{bsCLR0ie@6ND3e%S!c?KueuC=+o=b&KkTtzdjQ;JOC`?;4Jc^rPc^?}|E<_%?^ zoi|7xK76iLn7?8&+wu=yiynBiKI#$raOZ}JMaUGf1NUq@-P+V8PTN*ClsEj3`THs6 z;goGB#O0KD`~3Q}U$&`R#B|H7EZuYRQ`g3%f)yIN3{N}tCtgZQsR(O%Ir--q0gG3m zob%Wv-g3F9mmXYMuDJ7_!uD^UYNmWn{>;fIx^yY8|Ka6747X3#_#Cq%BELd~@dNvTUwivP zjdMEAi>RnL-z{F^R+!cJ(zrP7&C)zAFYd(W|5P>|FqG(CUc?|HxF?`#>;6dIq{rNT zeNRLV-|<=J+jr*IMo`e}W>)aMJ?@*N&6|BDZk_-2b;k9LUsvz(Xr4TqW#)q&R{HF7 z)!5o4CkIaIx)jvrF4OI7xYXsQOa0!58)t2mD(;-QC)cA}SVCqW-_M!6%Yv^&2p(IZ zwo*g4Re1h9l`sV+p*yA1rN!>~t~=;hYbLasm2J5Zf01!^^^J{EAY~G|-S)?BDqZ^U zL$6MNd+*wgO^aGsO1OCXZ0`0PY~)Cem>e=?+L6A)Zod~AsnHlTUwY<0&Jv)8(M94%z|Bh>mvNZ&ymhABJMZqmT6SJ)goR_+M`WbS#eJ9(K6w`+5z4FbMd4H90a4Y}%dbOiYmO=mE`Ri+& zX5Xmk2?!N;I9GU~SGn0)`DsCOpwj9MY*|~m-oDk!u#~g8-ubOe^vbI=kvnJP%>4^8 zmdH2;#Mtt>UT+hh6XtBUF;T)GIYoSHp{VBZOM24B`gtnne%yBD%npyci{qv!CrO7UR=}xaGB5Zfw=;ICFvP{Rg;#FdqA_89ym8Twoj(tsu71?< z)ZNvR<3oQ$yZZGz{YxJ<&Up2VC3@q|tV@fwZe)A9Nk(PznL#DFF(#4VfJq73GWYAUcZ0vGv4*U z@tfP^)dLo4yp`Ek^*vQ)pWTn|R)_r$3fJH15?4}wa96)hR>P}X(x|Sv<8;UrhG+S= z+GN+SZQT9#!JPFLh4OJ#Rj(Jgp8Gl5?oi)#Ia!yw_=iiE-`^OKvV75=$uF8Uf1JL4 z@rHn&>3_yjZY`0bDJM<^1jhD03r6p0&L%x7L%Q6Hih#*1vj|&VKylxewpIwO%*Lukd-*IzOuI@BY}fwagFQ zT`f;EU9sudt9e`Sp_36&N1rwkBjQ#&C*XH}Rz%4<6e47pCAl zzwiFSWwHH>tb&)b4|nM1m^_va$yl?xH7K%s*Dfo-mN2cd%sP0+Cqh&VNYUya;6I#2gc_2Z+LpTFg!w| zsj11}s9*P^Pf^ByPpHNGFSI|GF+JgLkpDq>wFCLfL@%9=wAd={7`OiA)cdb%KQSNF z|9;B9i#yW(`_T!X8%l?NJ}%_A@x@%`?q;rqad~RYyKcEz`pMVu>(>@= zF$ipV6dv*JJ|YRaEi`zsE% z#Ov7IDL*;oey0VCU9tKfrHyyu>)*9K+5WMAbM=R7f7ued?o4|)y;!JFWVJv{CC^RW z!`J;DtJNCsVznqS=IUQsMN<>`j7m3QOWVzAVxI_O0o7KVB znP)$G|F@eZuwy-g?A-nb{e-(k{xRYN_OlLg!#UR^Hs zIKR^8Q0E%HLzTzN?AnUu*Eepyx%tI~i?=$a@jc$I>UUsK`}9L`8PX}K1@U`W7M|@q zp?WN8jiGUh8pDC&Z%Gykd{=?_?|CG-DOJ6Qq)VkUvQPjOPNGiFZcRa%j2YjC{V zxn`xB7gS% zd5_r~U;V6Y-(P=`+dkH`h>N%9QtwaSl8fnFaXc?eZ0*-hTl{kO{mffunl#vg1q7Y! zmaRUwx6{lqMC;-FLysGe)tZ>Dd-tDZqw13n9u7Pd=gyORM&MA!V>edm|R2NymS@Dt`;=XCDq`odR9 zQdzf6FJzTkRP8%ZGC@~6xL~E5Mpn*=E9y2IN{^&$cNbJq{CV=T7V968y&tS|+U_UL z=@R|0J0PPiep(~feID1|t(^PkCC~1({hRH#eDNZgEmPjTtuE^ zZ8Y7kf0Q}xhpe@}`tQz-#|wQIs{QaiqWi;i%D1!pR$mMrT1K4e>1Y0)yF|uUo#*VK zgLZ%Pc1YGPeiEe9;y-=%r^gc)1UN6g+L$4py|~z1RB7?qfG}h=O7q%7zeo1$C=|POB;n2S z{8pi_hvwO6uZUPDw{P=uNy({PM^riI8Dwh-OkdIvmOX1~P z;KuZvlC53_%I%EG>lr_W_*-ap`##q%b!~TVG->I z1mZs}yI8Vl>uWbNv%W*&w!wjXDz(;@Nlh~foSW7>Z?fF?ZHb_UZ>x_$Z1$$0z~xsD zS-2UzaxW;qpyKGM&Sk`^xplG7&a*t%+$kbHO(z>x&obO^ za)RafR?C+wuFw3GY`XuzT}MBa{X7TFtyfLBedNK$=#R=;!Vgwzuq#*I7CPu||8L>? zs5aBNr(&bkIwr+1Z@RSVtkwAi;qx3<7_gL0Q(SyT;n}lILK(N~d#@(?9r^xbCe!DI zp^Ig&E$I|wv$?h`zph4kQ_$+fyd!EKzDs-7y)sIf!u@0F=>@sfg8dR7gHyyLU-_+e z{B5x1=8gU-eG2N^Z{0Y!)!NpQ{lNJXyd~SrBu#?#+kMh+J<^eGx;{VFq3pWXW}eHZ zBy?A$6s@_jQS6<|3~i^R#)bM97wWinE1$?n$z{L(ZuT+D4f%DYMpI@K9_10vIpsew zcgD2i8G)fnhr49=n>-5daXBcFy*sE;OzV{5fv+qlLJr02xHin+aoc^yFW-Y5#nH8U zC6Av>IynDdXLZcUOP8+LII`q8Y^+g@i}gOYdWw3S!ZT;BRMiKQg#s=m9?4%8y8e#^ zZ?SjX!~A{uhx`kTkGI^{R{L{qu~$LN;tA5JvTa>O0ZL0P#LQFXwoINOw&cCLp{}cj zSrq#NtHU4exZJ&%a;aVD_kYIudo8Z72|5>ow(Qo3clFtj?RbLROc6Kz&xlr@>hC(*$W7W%k2frun+q>_RrS46RMd#ED zezi~cY0D@v{iz|~GVxaD`G@EGs|4ro{CSvD$?KZ<633fQ^ODz37R)RPm{E6Omf`XD z^W^HR7O!KyE!lb5{*S-@AD$J(6>|BuuRK5f{%3J;z25sYe*1?nq?}zXEjsMQ-1T}k z@gCY+{N})7!JU=9Zu83y9oDyRpK#Jf&C9mR>+t-0Z7rYp1rpL`W(Uu72=QC^WB>Ph zN1n|l%j6H9>?u?7irXD_)A(KaMV|e?pWR^enJig%uHwhibip@g4i|Pc+~37NG2-9C z$huy)Kil^G@6g=u<0$X6`pDMTp=ysO@gz&`?3wMkPkzqXW49!k%x_O?%)PznVw$=9 z`acg7js5LQ0#1DjP{?n*qR(P%BU5F&eVv-%|6e*{a^CWX7Hg*;_WNKy^^J+$o#{M& z0?DV=$sTTcJN(&td7Cy^>^#+;ws-J8gFhc2{`pRKq0&Fiam?*o!^h9x762` z34%k($8L{4ZR`%Q5In}Qt$Zp zbVROeODmsaCOcQt^TeK?%CDB+>s1JU9X)TE!87BUDz|1)?!CW$OyPQ|UY2mZQudn7 zKCaDwm<1#xniAp-`RWTewmvwRX?e+P${&{gP<^G41NoP>NLJOE`z<_}eKhx@cGpjt z`SY$Nxc<=nQTsiA^PheH9tdPf1lRR=uuM$dwlu6~_0^t@p4%e!CoWW|y_xikDgT5p z_rxD>;|rL%4eVXGihbAT1wFX4(7(`XHEV{x+v;GBKTE&4&41 zUvEEUawZrU)d(b zaQOG5li}tQm_O%+e>{G_zA;L6`SatZ3NH_t3fGAp_!0d*w&J6}n`!w+Y98hVF6!in z+{Cd@Pb;Rs^Jr@e_lfmc?$O;sPoGX*ksmm*_S844l$c+98$B~UygFPn+hubWwDL7< z^=GO3JKO!C=Z*(%F7GWm+BhdaFgeNT=QlawvflBpPO1`NEE^MUE~u>QW2<}a^Yf~y z^vBmLoZaq}cle5Yc$|OqJ;O==r3bz?WeL}r1o0{UtJ0B_el}}XyIZ7;-H*4y9j7)i zR%mPhr1V>*itpQPQ5y~;aADA&oUKq8zMibZ2SLndxb{Ms*94*h5t_1 zKQ7wY)^SGt+k7`!<)*1O{urE&?^jDcyeInO=C+bq`gdYk|74vC2#C7Qz5o8hg$De= zb-Vxfo=%lgGMaBuu*|>iN-e+OyuW{B?(M4I6jU7A;%JICn$iXBGY()xHNq%FVxQOHE0?S}Jp=vMXXc?}~}#|D;u>d=l8muw2+G zhE2&>X~zDS$~FIvE#CY2a@oh#S3U_UXE#v)^0&QGniq~;#my0v!{=E&CS(iLi~Qqjdz>(d*qZJ=hb^+ zemR{>X3hI4^M$(h=%}Pl<>LfJ8Pod9-*!Yvi|7CN>C;+rD#gO;#z8lW`8|&pTq{|y zb|>f7Q(jZVrZ3pH*;=abfyH08WocDi%v}yD_WD15R(w0>f4A}4Gqo$4+6y%FUUt56 zKAC@|^V0vBb1go7bfrZv8A-X?Ni>cGYd^Vs_2Ps z`QELoEz~Uf`9aB?i#KGeM4L8NL`;)ibnM+D^+#V<{xJJ7Q}}zr=f{=%?(6TC7Ykfg zvsF|-{l)jC8)m)fjfAXwi4#qM^B7Ne9oVF_K>Jt0 zUN^X%=6|6_ZPftXijTx9nmR6@3!p(Ccl*vf0%y!!OhhnWsc(~T~>l;LT3CvcN@`!B_XzT0LeD=8~4 zu9&y{&=LtTM>jV&x7`_ | `Project Examples `_ | `Source Code `_ | -`Bugs/Questions `_ | +`Issues `_ | `Blog `_ | -`Twitter `_ +`Twitter `_ You have no need to install any *IDE* or compile any tool chains. *PlatformIO* has pre-built different development platforms including: compiler, debugger, @@ -27,9 +30,7 @@ instruments. * Automatically analyse dependency * Reliably detect build changes * Build framework or library source code to static library -* Build *ELF* (executable and linkable firmware) -* Convert *ELF* to *HEX* or *BIN* file -* Extract *EEPROM* data +* Lookup for external libraries which are installed via :ref:`librarymanager` * Upload firmware to your device diff --git a/docs/librarymanager/config.rst b/docs/librarymanager/config.rst index 62562296..fe6e573f 100644 --- a/docs/librarymanager/config.rst +++ b/docs/librarymanager/config.rst @@ -4,18 +4,17 @@ library.json ============ -*PlatformIO*-suitable library should be defined by a manifest file -``library.json`` in a `JSON-style `_. -A data in ``library.json`` should be represented via -`associative array `_ -(name/value pairs). An order doesn't matter. +``library.json`` is a manifest file of development library. -The allowable fields (names from pairs) are described below. The fields -(:ref:`libjson_name`, :ref:`libjson_description`, :ref:`libjson_keywords` -and :ref:`libjson_authors`) -will be displayed in the search results at the :ref:`cmd_lib_search` (*CLI*) -and at the `WebSite `_. -Also, they can be used for searching for libraries. +Initially it was +developed for :ref:`librarymanager`, but later was accepted by worldwide embedded +community like a **standard library specification**. + +A data in ``library.json`` should be represented +in `JSON-style `_ via +`associative array `_ +(name/value pairs). An order doesn't matter. The allowable fields +(names from pairs) are described below. .. contents:: diff --git a/docs/librarymanager/index.rst b/docs/librarymanager/index.rst index 774e90e0..5dcc323a 100644 --- a/docs/librarymanager/index.rst +++ b/docs/librarymanager/index.rst @@ -17,8 +17,8 @@ You don't need to bother for finding the latest version of library. Due to .. toctree:: :maxdepth: 2 - creating config + creating User Guide <../userguide/lib/index.rst> .. [#] Inspired by `npm `_ and `bower diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 6ad1551c..f211fdb2 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -3,6 +3,10 @@ Quickstart ========== +.. note:: + Please read `Get Started `_ + article from the official WebSite. + First, :ref:`Install PlatformIO `. Print all available development platforms for installing