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 zcmZvBWmFtr@Z}H)ZiBn);6Av!ySoe$f_oU;EjWST?iMWQ0Kp}=y9E+F!DacK{qOFV z?Nhh!`%tG&Rdx4yw_n9*sL5lXlArYTc-XtRQYlJHQ@Ogk*g1T#1ps_kbG0El+Q$TZ zl%s>wlwGv&k*Tz#;)3y#89>x1*hlOwFl5(16VKy9nJxQbML+czyXZYsPW+nk^xk> zw$U;GdtpG$v|g+%z$}Wle^Lvxn!xsJ_5aU>PwSI2c4j7h%qvo8IEujqB(qhRTEpKcGh!Qf z_U+yR09TzZuz4nA_+b06ooS!fbMa^S0(wBOonnd`0AMCV$F4KhEIy130LT=CfEpx8 z|H6n^`w+=s@7G~yPZs>)Qgnm;QrJ?cHo;`>7R)uFQcRJP4dfsTj(G`k-abwH$W&KM z_I}-VOi@>?2TSBU7*kgW3WDSaGOi`{YBZcxtO0EzGU1nqJ8GB$0!|zq)o3)HCXI43 zp8}UwtPYi~0{NAw`#ZrX6S?on!Xp6g(5J{Qd9JjOCQZ?K^cLxk3IURExgxZmHlAGB zNdyHsKi$8Ph{p359{sGg$68GilOE>m`$dGrGx&j%eP}?c5zLB`YCYaaQ-fYTMAD#F z1K%0*&w9Gi2LUHUwhx6L!AFY9l0s6!K*d09S)qc8jE)z$iXwmlAFkQYNRwKj{Egu| z@P3fUikmCSK!KHZ5hn?k13MsEdQgB4Cq|l^vE%bQ#l{kyS)5t9*^gSZ$E=k(yb2_= zsiUhlPEAOHX{=N%BN6+#`vdzt`=tBSSH`HhRuXO{ciOv5T4Rn%#0S_1ya$N3S=^Gk z#o1aL6@@xLz9b{5+QL??dd;W`Twbqi!O1WJMdi}kqVzcudqVqLhx%Wh-+>$H6l$42 z^=HSA<$q=Vg8%D-juD9;HXIFMBF-T~B7zY65Y=a?lo8Lx5fAHd3UK|-I{Je3#YNWu z)C&59pFD<|u9VJ@P731CsjMoi+N?s;z1AJqNvbr{4y=>Y<>HS!KmX+6I7M!QzQoiZeee^&U$nmW6?EFyvPafR>u^F8XaSeTn zNaP2fn~MlJ$MD*vrnKpRgmkH8x@G20cyh;#Nb!PPf*e-7!;r}y-JbK1^H4DZA_Fyp zvg(QIS+{p#io6u zGQ+dhu8$E$f`+9Ax<;nWa<#d&^oyOfo#nvt4z*OZ>bynBK*MG0XlrE~al^qf;#ys+ zb8Da_#EKBo_M>j#EVVl|@OxmwvnUcq)Cy)bxe+ENQXz*b#z>ea_BgFrWkt;>CnbV_r8+nKR44I|Ji@J zIn6o!rxk1UXZ&XlXHo0<6TJD%d4@b5KL1xD#L@E8Ii0p@pz6}fS_gp*7o^rj=94_<{~ee95HH+Ry`7Ew%l~pU<__w?|o1 z$x{xP5gO26i$9Sp4=v*cpy-SdQ4#u);)$-&1|&0FnS4Go>(U-uG7mBtGMhONE_K0r zHYGlgSQWdY$g041-tXc=>~@9|3kJCciXW881ld7#{2xE`Y(1S`NA2eBqU{9`W^s&| zy80DP_5Y11C#Yn{VHL`dP>EIpr(H;5gDME(>925o=o3->`pNqtG#oShGttY^CLjv6 zD+Q3Mf6AZaE zP9TSN-s3g45lt^YKE}0iP^2S`IyHZ;d2h&u+A3A{OUH<5353)HvDLThos1b1%&5*| znLM3n9$Wh?@bx_Z^%SQcXD6k#G*Vfgjojd{yT(zlNyN=>4RsIyJxin>VvR_9Y%9ol zLB0A^KeG%(U)%KpN#T*862W?OSE_V291L-K^d5;U-(2F=j?p=3yr0M~s!#Zx~y8-%kJC z$gXi@PBN`^hP6s}6!(g>ciEPYPE87n>y+sH)p^k2KbzfXv0S?QICDlC&~?N6XJO5_ z>-Je}v}a8hPFHooZo&3Z@v-?;)BWzS3Qxepr#KZb6?*P&fnR~f(k<6D%iTM7)JRqyzKnjNG$N^f!qIftWE z_EolAj&}B=v6b<6^$D?=#gk3{C;2r>tgpNxhJH%dI-?G&$DwnnkgMtV-1OW)DEs}o z#adBoz>)RTmLrzS`FCv3omtt}xFg{%;VF}=cF(J(wF6xJcKz&nA#>*w&l8cC)H(Ix z&aa)>bsZ*79cTXCEdh47$E0}zQyYJ~{VoY!7Z>sbMK`*y{atQ<-2U4l*nqk-K2MEz zuJ|yX)pn_Ong5kIm0XeDh*}Ugepz2WUk`HZ^C`HVS(m>>j0l^4N&c6FCH+3>OVW5G zM&$22u$Z9WuDJX2@l(0XsH4K{`3Gqa2Nn^|N6$q0Du=K0B~Xf00?CP0E8|n=0D^B0E!_+8A%=A z)jy_wzB&sV(DU3;DI6)O6ib{YY${<(6l@!mBCS%8UI{>fcU&6F754d9Syh$t&Ooj@#VXp>5R|UxywYS_-Uvp~?8$pL8Q0X*OxB6V z%fN%!*x1ZJdWb)$`-DXMnaI3XFlD?tq7QXS8b<_B~h6XxIRaI3< zfNrN=tcj_qKt@_xO}VZV7fw;B0$obX2WMwWtF8|}Q8dKgI z7wewpwR?PCR8&%MoD*ubjXekY#rQpw(j*|l-8Geep5rkhk~cyoaoIpyXP_N;XJwM zCr~zS>6v6|YRc8yn_~54aevZ)4UaB(7j5gG$=V9ce_p?SWM$>v5U{D^;NvdbR=8}( zoM*cGS8yf2_VtvjC@ki$b^f?L< zAg#f5vDt;+haTNa23lQpvMDP-R`Zfr-ba26ZEZymbSyjiE;1cfUPK0&xjKZj8%UDm z^_8N*0dDdnT^Ae+-;5N&Hd-g=GR{v;#_-3a4ewtvH>Sx+gz`CwH80a=adP~Fb{u-` z1bBJw7;dLq!7P_)cp8BT)a;7PxJ1&6mW-DzM_Pf^;A%H+ctS6F?zn~Rc=jLh{kroy zY4C#y&QTf)M9z?K`8xoh3^B@+IdUM_X7s(q^9goQMKkMr2gd=A-wcLgCxW?}-|eWZ zh(Tj+glx4*J2Ko3zH}ZLFk+EGwVtfK5%_Hw22~UfR#!0nM;pVBUw>|YE55K}22cGW zVU3#sCxpkkV>evKp=qF?eRyu@pC$<=e>zhAjhbQ7t2+ED*7>eA9L6m1wQu_uN$ls^ zU5l#GnUyY`v@jrB{Req6Vpd?giHk2;pdGAqJlgeHgMO_8vwA==taze5)F0;Nr^f)^ zo1!ylDE4gKsK7f=$jKTjCh1JHNsb)$pguIX4o=6rwln&-b}{kjLH8*-Mb4!211DHR zpSsq-IpsU?%rBLVV!bq4H!H_g@t%lKCO4@&_rQ}p5}~%B$f(Tijutt@a&G)3V~pNj z!{h}2)H>KNUNCPU7PluqlG~LduI3@I6*(0y+SJY}Lp5`!BaCc{^-=VUpC7CrkFMrl z>2P8v=aTlVf+<1!%)sQjDR5eL_Cn=i7)P9|Zw(eySpVYl`{UL{SNnn4?6!Sua@NA8 zM}>0=b#sIOAGm0S+=+E)6MT^PgOB4$-JB{U%ZWwm*Q_fbxY=c!oR~tdo4|>n1IO0u z3rYpSVBgi(uUxjS_74;(s}lpT^Jc|?J>1BSMSu(2k3YhkBG+cdQN)8`X9Om_8aCj0 zP;%;)P#HQV{sH#R)f%IwVp==Zr%@eFY?$z%h3^A;#uHvm&?kZwNUe%=ip7n*lObl+ zBoSE#`7?2Jta}4S(kVMx_ljIv2ZsSF1YosvjNI}bK=ED79V~nvwa35z$jH8e3xD}^s9>G+9=^E!`?F{c0a=RBQ<&x-@j}BUL&J}mN?!#2m3vg z2P-ThQzD$&-^ro8j%h*>+d*!Gv-q8eZT`H=u6=}l*WCpS35PihwSWh3kj$!O>?Cs( zA0W#!F0K_!QACh7`QrYO3s$2)aKRDNf7o%Y?NWxW)hB2lEBKBTK5~xK)`~23!GH<5 z)cl|^>Ua9RXyx1r1A8so?91>C-q+F%!~+9Ufw)+{sfgtlN=4fW5xem?7wgNsV4XCA zzD>~>xkyH$aZ$fupWs)M=PQ$)wAK+q3L1<=wM3TVNJg+p99gAT*XUJjqt#nNY=DCp zj^tS@8(+Qfc41MYIsHO zNFNU;j@!lp@N07|X>)Lr55vwoAV49>yHW4;_B7gGSo1WDJ|9TQKuXHQdAI7p>;8_Y zG#QG2BO#mX6a&qc8}DYf=gX-(HmTZfu0Ew*TVJDK;+K|Us1KCiakZr~U7NHUxcJh+ zT_E*6bSLWae2AXLqob4F@FuJOFQ_$ z6IpePZ`BqZj&F?UBm>o>7mJ*jfFvbdDxU6p)*n)0-H9-!dnlV`R#$_wzuS49_`0rQ z^76M7NSDf7-RlfQbs+BB@C7d=P=?K6Ja{9c(LVfJh=!5_IAGIDwV^r7pW-!i2_>f7 zekRa{Nz)#;)-AmSS$a@#jzM@YW|N1k_#aOUNWOOhhqcmm&$j z>Pd?=S`u+u+Yq+6;WH1o z3IoT0KGvM3GbuB@sEMaaJLvF;f7)YGzNrh&B22|vERZt{>g}~s*q4+Pya|Ih5K-*O z$trSP#gpRGzgOMD!_!Io&;AeoXZio7|9nJ=j;kdqnTDz59y%8*nV8@72-6$>hla?0 zVG_5&#n1uF%p&#uTE8)U&Nt_Azw5Xk7!TNuK9H9cM7~Heh++!#}CF>EpyA>Kxhv5dT#}d-e zZf|fv$(fYmh`FI*(c?O4fJ2wnNb>sHkj~TXuk~OzN;7}|-vzQ$_c>zyiAxmZGEnoK z((DruvgZ2-5KA)WywB#1gNIugXb8 zzER|JuW4j0{LWjGMndOBqPv;bfIAG__r{$~0JkHn&n6XJ|6=}hHT>BO0CEM9)TkO$ zFlz?EJX|OwmBsG@y{v^ZIjaRD@rRsz=kO4bFo{#7 z`<|KgBG29mJX_Ri^}837rZ%!$73$>n)Q^Ph#rXiQAJ^`Jxo0IQ&GF<|ptD$9R|)3~ zV(VM&gK7!%`Wd|T&t;w4e$pbJEqaNpUBjYQ9evv=;;33!T*1x){kic?wO0%`&=>Nm zga^ZuL&yD+Eg2&>{rP=ASCR6qmlfaEgkk~c^R%e1bxZGzE~%^4nmm}8FihEyukA4N zJL%5U;a#pwiy~sZoc9SvN&5VH_LdAs*WD&XSBFraNbeny$r#y9VaYfR1abs{^Gzbu zd|`edqPV0dm+oXGSnCyuvn!;!*V{L_M}gq-XqvhtH5`n)=^HSGhK6$fP>b8WGU9n2 zVK8}h6Q8orw0PE1hfy;0xs>70jvIno2qn$xkJGn)2VTL$IBv((@0hu8$A)5%|>J=G+e4fRzPBVP$ky7DJmnIvc{(fC+hi*U<$XP6B}J?@UE zEYl3!@3|o_{}mwHXhtnG`^W(QeN|3Sjq(!~N1!Vz0Q=jnzQNf!`h|q_)!N|}c2xZzb}oA{xxunjD!?J)%Me18x24!k$X?J1%)qh8mV|X|@N2E)(#pyd zH}dB6X7e@~<`AHFuMf7Z)L6?3IFB;8{$>-US9>`#nQD7BHi=L)?BZI!@elvKA$MR> z4rI$R$UpUiE5Ly<2^c!R2-yq$hpPa7oO0#^1KQ=gLhHp>A~_3t9mXYJ_6h#n?ULME zJ_1-T5td^@+BrrLg$WTB%71Yx4#V^3T$?qL66^GZR8bYnL|(dnHox z>ABctMqSY^PUbumrYlwYV`?z_{f528B0VVULz-8bfBl?Ujn2T_Yok}|D~ihOH?t?T zv2``?LMWV!8KECCs^Q|XVF2`b+*pA)`ZKMa+7A@HTei)7xeJmO6SyHSm7@PaMr!Q;e&%rzLH#+ zQT}vUxLABb(qz=Vr2|{+to!$~NW^uf3dwB|0qNcuaqLBLd`VFle6y&a3Hw~=lkbA?B6*s^aMmQ|7*96gp?BPcdogkH&$<&6fKko-Xejf!daAaI8ORg zB|%O4a?vz&NT=kFv*bK(Qh2hDxi;diGCF3e6La5~Pmq%xa?$(Do8GvM;rbh796%M1 z+U|KLP659Ums-r9cLN=BR@#O5FB_IkVzZZ4?bB~^V{bG{_5MeCg-gy>-X5al$$el{ zZ_o^yxGA4IDn|Tl!o8~J3faz1mnH1IU9`*>gr*}xMLadkSa^5J39jG)W{??PvBSr-iG6wO zUvhfiS=*#Ikqu(=oqMKBD7D=Vu+?xe>ZGQA)VrNnkvOjL{dDvK`}g#Der99QcCD0S za{Mqd&nVL1HE7c&52T~MAH4>>f5Pj&5dILkW%)H0|DsdFKGHlR1a%8tHlYQjH_tjJ zM)cW9t-QF1>|5H|DJo&nC~sX5nwVSKwA!RnyJpK_N7oPYg!A}kdKbre0#<;2A4sDtzWN9btT^v9{6$*M<;)MBElQlUQE;^NaF;sjVCHC-zQ2M)Ph-GLR^RXn_Ve^D z(V-`IZiJ^*4LyUXK5X-=vKh~!mfv#x{E7YgqS~66bb-QxR-sw0(xEj+p@Ka(B|s+C z2o-EorzS1U@`Zk|9OsF=tItn5Nkv9f?)S_s#W)?4=!#aNulWi{XEGEP6Y1^>f#Bi!^0*V`?a8i1xvNT+x;)^ zt_yXG$rnpvfQTZCWiHT9v`t#omLCThE^bK`p(ornX=r!p;|0zEz$BteZ5smO6SZo| zN6v36%Sma8RE%w_%di$=@AUiR(@h$ZH_1v$m%XDY3NeEsf72EQZxG87!g~Q zjeE^R@vbE_BHve2US?KhjCyx@$je>EdM1Y zz+`lGc3wmh;e$luCwene<*Dj4Ml-5IX^<`bb}Ej>tmU9fnQr|P7{fyuy5rL0(y#8u zGaSCf!tgXztmJA^{F&62JTlf@gQgTrAYhXlo|;8aaxTxsCdF&7_WLrTlnqqW)h{{xnwD;t@XTp|AUX7XFnNIQt z=D*2Y6dI*P!V<}qgOAqrsXzyJjV$QTY_8$+JPN2#aozhh;+Q${Cv}b|^a>AO3K!86 z#jD2`Fsz>a+zv~8=NE~ztROgAoIsvEz6qnh+v87PF|fl=RW9GVe}F?g>hq`wgOaGf z(m?)ZWcU>pwuRjnC+#m1I%vcXHCAv8hmskP@dnz>g+l2WRAu;sTd!(IxyHE~CLj$#kx z*U6z(;&%dT86nPVMKg8+l=V+LmOSd>o*H9U8dNSJ^Bf2~B4qxeZFLO5*9TSt3T4Xv zViw4N+J!*+A6~KbOmsDD>#;iWfrzgJ_I#1BvmjGe&hh#UsF<1GsU=Ty*ju1$4JxOQ zd2s}u^~c@J@Ss3%;D1rF)0<=5wA25{e`-G`nF(a;^+rGPFe+U5EUj9zj9OHPmA(hr zA-Zl>|NOXx6tk1rq-<{G^Fi>Fes?%VoQcb$iP8Gz*WSoKOkDwVnb>Jn-0!#Y#@|gl zP?4S6=?5nEb5PJs8T&gB-VExkbBSZblRf8NR4c*SAkBRqM)om{oCH=Z$@H_gU?Z^J zCz3O)u4u!$NIRde{N%aJiX&b3v?t}82~_&Ojq}Pl4|zWM%Z1^ibwAvtp&m1OTP*pJ zFN*Y_Hb22*6A^`4m~&wUxgxi0!yE)>`O}^dl5{y}boyLozY+UG1=I>*PCuM4Sz_5;XLIqYSsrk3#Q0L1^e#Q;s<~1q zDv0bjH$Q^m0W`Gn{XD(SbjNt_U~#cj>N^tO?GSMIo?kU}F+xkw#);CKS<@8FlOg*6`pt zbWP?<(O`H%*ZO+j=F9YO?7-X6p zKs*z5v$F?JSa9m>&2pZ&@LOPel#z0vNyCSyys{t5{E3j6umAlfsDwg1niRt-S~gJN z&Le+#d-5@G6630XhLK_>>hW;+;>`Ds;HhWp-h92n78y6~VMB7gqL)wnZO`a`QeC^a zCw1DUIdT519+5rfo~El)R8|R>+YoY1ht(dS3e)is_}gl016lAQTlb4KXv3&T_IV+t zOS{5u1eD_nnIO{e&}8)<(|&pxD(=3X^S-Q}zt)B!rZTEVbY|{nJYk-SM9jiny$Px+ zE|raUpNO8hC{S`xXC%}Y4a4?5wsusM1P!NJX#P#KDOBT!!C~d6PROhJGWNA-{f$AO)T@i>eLsMU6YUhuQY$@&zfIa&hDAxv|UIkxXRUMvDTGo;{J~ z5PLU5jzg}L)#IgAV%J%Fl^J(6*tdtnfDwRYG48U!EBC7yubs&0mI6*T6cj_#YFs}|qdhM%3o4vAmw+t_ zGXWGdJ@(6j@0J+gQ8b2sfqq=YVa_bL&dV>V!+Wtbc|KYp)Z(X*ho1Epn5DUBerpr=`w z#BCe=j96yp9}6EVK_|{}ckg>MrM?lec*ro%%u>L_ejIZmJ?b(aGyD1_7kqVt8m+rZ z-5I&87kB5gw0*zvO$4l9BUd{+G5|l^8OMc0!g{I>pxd`0L`J>v(8VJ*}-a#?>!dz>FEd2Zr{*Ie~e)7 z|L=h;+<;v2Z`+$H@7nbakE4vLDiHIpS>sr0ykZ?t?P`Sg|0?OO;8=xqwCQ~P6 H5&FLX#N9Lp literal 0 HcmV?d00001 diff --git a/docs/index.rst b/docs/index.rst index a7b2254e..b72528a6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,15 @@ -PlatformIO: A cross-platform code builder and library manager for Arduino, MSP430, ARM -====================================================================================== +PlatformIO: A cross-platform code builder and the missing library manager +========================================================================= + +.. image:: _static/platformio-logo.png + :target: http://platformio.ikravets.com `Website + Library Search `_ | `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