From 94935c76320a5ae14aca0aa542078086670f7f34 Mon Sep 17 00:00:00 2001 From: Dag Evensberget Date: Mon, 2 Dec 2019 14:05:47 +1000 Subject: [PATCH] Add marketplace icon --- CHANGELOG.md | 2 ++ README.md | 43 +++++++++++++++++++++++++++---------------- images/icon.png | Bin 0 -> 5556 bytes package.json | 7 ++++++- 4 files changed, 35 insertions(+), 17 deletions(-) create mode 100644 images/icon.png diff --git a/CHANGELOG.md b/CHANGELOG.md index c8e4e20..54a0540 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,3 +15,5 @@ Fixed image in README to reflect new features. Tidy README and clean up `devDependencies`. ### 0.2.4 Mention support for [Breadcrumbs](https://code.visualstudio.com/updates/v1_26#_breadcrumbs). +### 0.2.5 +Add icon to marketplace. diff --git a/README.md b/README.md index 6d7ea3e..3f62b8a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# SWMF configuration file syntax +# SWMF Configuration > This is a Visual Studio Code extension and should be installed from the [VS Code extensions marketplace](https://marketplace.visualstudio.com/items?itemName=svaberg.swmf-grammar) -This extension provides syntax highlighting, outline view, and some code completion for [Space Weather Modelling Framework (SWMF)](http://csem.engin.umich.edu/tools/swmf/) configuration files, such as the BATSRUS `PARAM.in` file. The rules are based on the [SWMF manual](http://csem.engin.umich.edu/tools/swmf/documentation/SWMF.pdf) section 3.2.2. +This extension provides syntax highlighting, outline view, breadcrumbs, and some code completion for [Space Weather Modelling Framework (SWMF)](http://csem.engin.umich.edu/tools/swmf/) configuration files, such as the BATSRUS `PARAM.in` file. The rules are based on the [SWMF manual](http://csem.engin.umich.edu/tools/swmf/documentation/SWMF.pdf) section 3.2.2. Automatically highlights files ending in `.in` and `.IN`. @@ -10,42 +10,53 @@ Automatically highlights files ending in `.in` and `.IN`. ## Features - * Syntax highlighting - * Hierarchical document tree in outline view. - * [Breadcrumbs](https://code.visualstudio.com/updates/v1_26#_breadcrumbs) support - * Toggle comment using `!` as comment character. - * Code folding between `#BEGIN_COMP` and `#END_COMP` markers. - * Autoclosing of `#BEGIN_COMP`. +* Syntax highlighting; +* Hierarchical document tree in the [outline view](https://code.visualstudio.com/docs/getstarted/userinterface#_outline-view); +* [Breadcrumbs](https://code.visualstudio.com/updates/v1_26#_breadcrumbs) support; +* Toggle comment using `!` as comment character; +* Code folding between `#BEGIN_COMP` and `#END_COMP` markers; +* Autoclosing of `#BEGIN_COMP`. ## Installation This is a [Visual Studio Code](https://code.visualstudio.com/download) extension. It is best installed from the [on-line extensions marketplace](https://marketplace.visualstudio.com/items?itemName=svaberg.swmf-grammar), or from inside VS Code `Preferences/Extensions` and search for `swmf-grammar`. -### Alternative installation from source code +Alternatively, the extension can be built and installed manually as in the next section. -This should only be required for developers. +### Manual installation from source code + +> This should only be required for developers. + +1. Clone the repository and enter into the folder -1. Clone the repository and enter into the folder ```bash - git clone git@github.com:svaberg/SWMF-grammar.git + git clone git@github.com:svaberg/SWMF-grammar.git cd SWMF-grammar ``` -2. Install the required packages + +2. Install the required packages with `npm` + ```bash npm install ``` -3. Create a package + +3. Create a package using `vsce` + ```bash vsce package ``` - This should generate a `.vsix` file in the current directory. -4. Manually install the extension in VS Code (you may want to replace the wildcards in the version number) + + This should generate a `swmf-grammar-?.?.?.vsix` file in the current directory. +4. Manually install the extension in VS Code (you may want to replace the wildcards in the version number) + ```bash code --install-extension swmf-grammar-?.?.?.vsix ``` To test the installation, open the current folder in VS Code + ```bash code . ``` + and view the file `demo.in`. \ No newline at end of file diff --git a/images/icon.png b/images/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..9ab646bd3116bbf29603322c1fd5b8511d0929ba GIT binary patch literal 5556 zcmb7|RaX>_*M%u50SN_0h8!eBK)MHz?ijkITXGPFZlt>g21)5|5D=73X=G?nYNTPP z*WWkzzw12v?6vmQx!M;eMpIpZnD8Yb1_lPPlA^5kKM(#-__+UeKluIVKf|?DQIN%W z{BH`n%ToU(1a69ko){QUDgF~CMh=|%Ux??Wq$Y>AMTCVd$c}!YC69seLRv{yTIb{P zQJ(Kdow?OPNg=-M>?-DPoQAr{EUD1oBnD;+fkA&w_>@PVCEYprNoA#&bEC$ z>?TC6;Agk_YaSEbJ;^DM$RT`_R(w(j13tt53pW?(l_Hqk6k|jyn-UmLX>BEvamTsnpN1!e2xasU?a+J*J-4SBbujA2HBQXqr`6WU zItW_xoW}iQNk`zx3?50^L$O4k>2Qtj_{ZQ5nvPNj8WUoUD+qsGR~mz?F&>=ME7L;y z$VqzcVid$Khd(4;G&=7r`(JyLa6RBLa*()Lt+n{|?EW2nJVz$BDF80Y1_|6vsU(9y z&1?3*m=W&=Xo9Q_w9^*QyA={Z)3)FY%HhV<&J3Q*{5R*cj@0b;qae7cd11v2l@On6 z({kWa!?2FC>tFbx9e8KA>f=twDR(=3+5IUy>K=}CIpTL_`S8Fe{40h=IFknKp8@_C zp%{aZiCrmEfhfm@<1XoT@NJ)ITFvVdwj#r>?6|luDi&BCrDQY!Ia%wj8BP0LS*HG5 zQZkC8F6n|1Zah-32NbWF!po`SR3f<8Q{A^8&p4g;y%mCisc)m1rZ1LGD|~XPneJOA zXfNgZ1P>hXjPyAlp$r0gu#S9T?e_vKB^*X?)Zg2#^cs_2G?DxSveyieWFN2{fGw{v z&=%+)Z`6f>n8NCqJ6Xx>G>Q@rU>H~dvCRBuxQPegY(CK%zp&$(YmCqRdDtmN&n#b0 z2ZLh4_jwc!;IDv6swf!}pqx(R%6^juE90v%Cp)ZGiSG{(J)4ujJeFA{vN$7#}|aPZ37FeH!4h3IcmpTanYinPXLblsl9Uk8Z@` zYOAO48g9hpid+eQ*~OtbPW+PqirQPeIbXP$DkhA9Z^h+-S7l1Ba{P-{uD&uJ1WLU# z5u=f`_@p4ol}Ev5H#I0wxC_dy$Gjw?i1GGruw79ASN@oQAF(_xogZxr?k*s|&kAM@ z+{kvOMzNvajOpUO=eh>%sm!8Wo^e|isOzpMAT-K0R|OWGoa*T(2k-XGJvO66fOp%b zFP(HQxL4CvvT{2l>ec~9j>gHa!9|zTPvCl4t5J)vLG*85EUlk-6_#C`qp0EIJg_M{ zhr)!7CLF=yd&>V^we1ST%epy3D%ENMxDV=tU+ZU3Ja$q=`;2?LE&HRpo8Tc&%h-uo z#?TV?X1lLW=QFsu{AE`QTQ*`xG)yLxzZMKo zj-oW}XBM>UXfW8+mNE6TIPEUYQ5D7zaRzpq*!F^99jS59%9$DsNJd^&()~cG>4^Vj zp7<6ysgydSqa!83Fo1|Uxi8pyE`K-&2RCt~Ajmmug_nMKoeZR;sI#Qs_~98#CLp@2 zsFv7L!Ge~dccl<0|TCR#{aPxDj%V6__S+0DF7 zisc8y?kuj5Sj4h+M_9#=33Q%Z5A)ugN&?~jLsL#p3kJK$pk3RZBxZ3c|8u=519KJA zbg@`Yew}oPlNX1hfVRG_x=eQr`n7J=Wr|wbLgzJ)4M_rAFkM&XV%{o`y22E0)U4kQ zblY>HrZf9yk-5j34b|*8Z7chbl=Dv0ILIj0zAF7LHR#)0zs~0o*0p^mg(rpSai8>( zu(x<*ebJcn+=5yQwzwWlQ@hq}Xx}9CyP`>@XI{YdUzm2|(L8)fSbMy^HuRG&$k680 zf>l9>$iifo60!OxhlL#t)rm#XV^bzo1a+2yfhr)YGQCJB09NWo1G?K6-B%eM@O>+vulN-)pK|~UO9!` zWoeUztdm_{>ID)mEt}JVKo4k^VK$ffvf_OW1j#D&E2Qa??@cg}H+(>PVk7T<^0m~0 zoSkF&{b~nEXbZxiuiYOu2y0)$&Rt!UP*|V>mAo`srHt%9EH}k^_lEzN4O+1l0vL!8 z7TC#dHfM|)%KLaC${(fQNvSW4EiV>8X1qjcBq}f|6RjSvJ*IcBx7U5sx{oItH*_i5 zv&s~lmVR9E1^MO+C$lqGVf`=tMlu|oz+U#Ey;9|i!B?aeR}M7kx~A9Ucs)G6iz`Jc zYsVcu^D5md^XWn?6m@<@qeM+)rwqh9n0byOZ-c$k8YA*M^X&v5Uu>I!kJ>=)EwR?> zd{$oLLA^2YI)cp(<67acC54k*3{23>bb_KnYLfK8mydEEp)yRE4n98@O30Zj3D_9{ zN72^Y@dqJB`==ap(8`{H-(>-~_Q(=6A?J7c>ne`UCp|fT{~ix7EpSx;6$<2aZ!o24 z^_yoqQV6}X_z!QtsDyHyFW3F7b{6qIm=qHT;a(aW(u49Esqcv$y!2wAEjeD%`>rFm zmV>-+40f-r`up;rw0i@95@Yh9zST=;AoiV!-P#^~lY`#8g>Ec8UAE_*Nl-1W-PaBYi zkdNeiq*y~C{rGBbQ<}(T46KpZFO4$MxYlaoXlAkTBPL7*6MCD?;(5Xp5rmOS8+rtamI@4-n7K-<5ko8~`!V=Wjg@gXl^g zG;xxH4Aeb@73Y~q?)-W57R(y&KLWj~VC}^_H+w2<+DQf%k;Zb2~3YjFF8Te?h3;hC_ z00j9^bK@QU{3E0&fq(WQ@N7r_6VE)+c;A#MeQyR>PUNtBrFCh^0vh>}{8;qIcR07{ z>0oMc5&UL&^tYb4Mwe5*Wg~(?@HS?ma;~=cH@%@Xa_c;&B-%aBuV_nIvipu8$GAB5 zxU^?$9-7qSmo#s9P3vX}dNB_J6nZ*#4GsM`9&cw6G$Xt8rCPx%`X+W1T%?=F5Vf>i z-oN-md&&8vIy`3SRq3tLpCdnbo6R#7 zp*vEDT{@5=EA^i4&-Bq+l8GvEqPUz; z5FrbDjcLR=mo--6Uw;n{JaHfqt7x5eMs?(ad8u9j#&5U{ebfWIMSZU+lqpGr+d>*^ z!L^ruCzw@xK_fF7++E1J5UaGugUKVP%J?bpYL$9rq7yj5V4VOe40W=j?;ZEj$-f=B zFehqckyzwedM9OWdA`YhC6zZOCg!Pon-&_jFa;y@@c}OddRBjwRO$I ze;5oRfZURp%(tR~M<|Wrc@0(-L5616?_LBFr+S<9Oa@YhZKYPYK5qeaDao+RAX-w>4wF@SoHifM-p6+UiWA`l z=vTxF!mlndYRIt^ZRje0>0jHHo9`vheyKUN65>l8ICKZ>gZus@!v1QspR1Zo-(iqx zaq|hhXA|s<&^wQ#%h>RElgsvIS%a@&?ze;Z6${N|1)y6#L3BWTN4y{=Zv|nk5Ec;w z%H(rMI`Aw{n4^#12v!r{nz15yYpcrRLo)4UT6gCXn0yuKcQmvcl8w3+CV>`e0`ac= zDJ)vhnN3U94*Fac9H;<4dRS$59-V+z-I*ZcU8OX(388G{#48^0m$}4E+UXye5B)&F zz220#g!owa|07;_n=bpKgc3Z-XG$cAKWv38TXY}`I#PybCkMG0t0QDy$)Sn~0jYni zJbxdc=LRxn9(TTnN}7EYiHbrj!^57H75ic{18ua4hO9dfuU8LBa5W^I=Jl9Cq3$ z&@CvVhj!TmXJ@CUcfMkkfpvQF;n0Q_-d;}#nG>0(5+B|ub+quop|?w>=39oplGT2Ywo>V~NJf@N;Tcg?W9AqKliDYDUazjW?&5b)Kc`20 zn}I5qzqp&h;63v_Z=s^zmy-c7rDUf!Mr~t1J6qU#)U(>JGr?_f=om@N`@pWm6Ambx z#%jsvmpCSalHvM=Sz$dx9&_EX5I$XS|AJIJEx3tOcdI$wo({5=*CnKhSC6H8PF~Hg z^|1mzT;#*+Z4WPFueeL;K^gWs7*8^MEBUFhFlC$_fZJ1rW{EdHJB|WncT6h9NK zJd^*c_rOzfIFOqU;ppgYOA`%L!rQ7zz%<+#xNA$R(;7_XhKmU zz)V`C^2CL^_2nxa0ey4RnatE7b=qQ+r( zpva-l_PfZ!82%c1_29zDDs;!w@!&EyQgGGrh z`Ot}0TW=?Q9~G@wR*1-~&&_!w<(3H8c=E>aDQktkS9B^Q_xQ69ep43Ivksj%x@;(; z$rbb26)f*W5JB9@eWX?;ALsJfa`b&m8h23%&G@48kIHY{Ux(rugx=e81-1N`-RQYc zed`YJCt|k{np2w+!g*WF^A2TE`(09H$)J-M1PI4o{+d0&z%g8vMu2*+L=5v!U`W)p z`Ox~WG5Vm4-+bEUT5lKIQk2;$oNsAENp0Jre9ic0rYr<5GYtkmw=^|lva705@3)&B zo@MjP>OSh0Zt1ti%69$$zX0o3u+{K>R*^t~L30KnOrqI%tcH zMUft78JTsP&G&|azhLg2`-v6M9$E^2BU~4ntuzrmnDqB;t#w&_;3Ef6G$>T6pL&zY z^;N)c=Na^qRuwyl9J1b$*RtJI*aw@cy_6Zy3{gPX*)?oAU{YN`T* zi#m6Puqy=difw&S6Ednub7Wbqe{u1F;ZJA70Fzvt