From 26a2bbbef273135cbb8de3e97f0b4cba8e6e808c Mon Sep 17 00:00:00 2001 From: flin16 Date: Wed, 4 Jun 2025 17:51:20 -0500 Subject: [PATCH] docs(readme): add installation instructions for dependencies and tools --- .gitignore | 2 ++ README.md | 61 +++++++++++++++++++++++++++++++++-- lua/plugins/.example.lua.swp | Bin 16384 -> 0 bytes 3 files changed, 60 insertions(+), 3 deletions(-) delete mode 100644 lua/plugins/.example.lua.swp diff --git a/.gitignore b/.gitignore index cc5457a..621c6dd 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,5 @@ debug foo.* *.log data +lua/plugins/.example.lua.swp +lua/plugins/.example.lua.swp diff --git a/README.md b/README.md index 185280b..0f97b88 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,59 @@ -# 💤 LazyVim +# Fork Information -A starter template for [LazyVim](https://github.com/LazyVim/LazyVim). -Refer to the [documentation](https://lazyvim.github.io/installation) to get started. +### Optional: Required Dependencies to Run tex Formatter +To use the `tex formatter`, install the following Perl modules: +```bash +brew install cpanminus +sudo cpanm File::HomeDir File::Which YAML::Tiny +``` + +### Optional: Install lazygit +To install `lazygit`, use: +```bash +brew install lazygit +``` +To launch, use `gg`. + +### Mandatory: Reverse Search Configuration +1. Install the `neovim-remote` package: + ```bash + pip install neovim-remote + ``` +2. Start Neovide with the following command: + ```bash + neovide -- --listen /tmp/nvimsocket + ``` + Use this command for future launches. +3. Configure Sync settings in `skim`: + - Command: + ```bash + which nvr + ``` + This will output a path like `/Users/yourname/.local/bin/nvr`. Use this as the command. + - Parameters: + ```bash + --servername /tmp/nvimsocket +"%line" "%file" + ``` +4. Create an alias for convenience: + ```bash + alias neovide="neovide -- --listen /tmp/nvimsocket" + ``` + +### Optional: Install Stylua +Stylua is an optional code formatter you can install. + +### Optional: Install fd +`fd` is a file search system. Install it using: +```bash +brew install fd +``` + +### Install coc.nvim +1. Navigate to `~/.local/share/nvim/lazy/coc.nvim`: + ```bash + cd ~/.local/share/nvim/lazy/coc.nvim + ``` +2. Run the following commands: + ```bash + yarn install + yarn build diff --git a/lua/plugins/.example.lua.swp b/lua/plugins/.example.lua.swp deleted file mode 100644 index 037db8e43448d853ecb0c986fce98364973d8e34..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 16384 zcmeHOO^h5z748tn1dIuCL?j4@qOGvbdV9uekiiCv_=iZAycqDtiSXK^>h7AE_VmwC z-95Ww$2dZU1QLW3MF|O3WP;&B;#iR-i`bTPL4pH{1cCz+IeFI{BIOW-KoEuRRaMXQ ztjG2t2SDnUzMbm&dG+e6SAVa1-3|M8&9Ke2X$#NCENkuS_q9(Sd*`;@cimz&McnG= zJPw1HQm^~mZ}O$i4EMGtNyph1$Xb|qJRB+W?UKNH%}e5D(5lD1AgYHsuXn?|6~t*> zEbyosiW=fZN>?ux0~G`BkAcP%X$LHfK|Xt zAGNHX08avs0^bE51{MGg%mUNEdf+pF4ZOSBvKE2Yf%Cwtz!~5vpb6X$d)Iz#8ChAGEBiz#G6>;A!A-;5ZNhyMT`atAX2r6~I-H_h;ZT z@KfMXU=H{quo0L7CV;iTO5mTjp$zZ`;5Wc!;8(yo;4JVga11yM^nh;wUj`5pP@k3 z7Lk&8bV~h{MAKIwx#UW2S$@)`s8nS~IAvSe5%uEcLFnVnj(A6~Ea+rON5u9NyY7Q# z?1{rZDS|Il_UvU)e|He)3rgNVr6bIyuTdQRHHwJ2?AIs)qFu>judORhGa+qubc)y^ zBD`FNQ)p?6fg{G#e(bSk9xJA_`iwzzE6CcpTlbP~5GGlTc6lBR ziqTgwRKyou5&I(c0x@L9-l2u>aK1`k)f8`So|$%_C~;_7tiQlPqcWKb-7fCKxzUzZ|EGU1Snq1cl8 zXn$c$QhX~1RqJe@cb#rOYbUXNZ!HyB-d$%G@2b{8n~NS=cdv>cHau$PX)0pTY6+>n zPI4gB)-{b~y_u0+m|Ao`d#sQ`Gs;tH$I!MU=;o;~mD#aKyfE+uI^P@1z)_|8pg$R& zK|2`h_GQp&lX808FbrSW6LM%TBg2ZSBdgJUmUcB$N|%zdW2(%=0@cCnkRuq7Rc2(` zMmfe{vpPc^71rBHBwQ)x>uwO!hhHOEQyOCsmA0GFs1VJsPIW`>bxP$h3L~CjSf&lP z-%$Obn>^Y;4BVdJ(gU9{6&cGZtjZ{k&)%{c{ej$?%$v;`mn}sevmGaB#fcPKzw)^a z)0iI$TGU5xj0!>1fmPDGt?lfl_E+L*I(G22%=4o&sDQf@zx!%FKbaHOa75JQQ?g*9%lV$Gcfdgf; zD9PE8$RrFg-_k5TUXE8}xq+D70_zlspl7_8kh0uB#B5ujTWQL_t_ZAUlx0*1O;W8I z{-UEAS>iRkJk64*0lP%+l*XJ|`DXX*+_QzvwgXyHMU=8Q$ylC>!t{n@m&^gPt|0Bcx0u)TBiSkz{j%sYn)yH03Q(tUc5c+rhwh6PjD-RXr$aB3Y7W-8{2Q0)A{K zZNsn}%>KM<3L!t%L>G0bG^W!=3U&QvsR9y*LTDF5!tzQmHfepQ5j~KB(UDs;>TuR5b0}H9zHVljNFmy3BlnW~rjNbSlRizIKpxq5WkjQVVU4>TO=*-bKU5=fJ zV0z1eoY?;)vTw?d^tskY$cCB)BhsO0*GRrzAm$rsCx{vxJA@udM^nd19OhJ8iW}vM z1eQFtCnCwVl18HrqL;06YFCC>9;QMW&%9uM5>I4f_HFxuXjVL=gxMjM4&JJ317E%< zs17oVF~V4dR3R0_LQhn%m`7^LSnmrrZ_!*vw(-}?&n=xgf92xyOFues_4I3O&Sy&} zzt3!w>FV>x7hgWH_~fN47fzQ&7Q*J{t~Ix%$DX-z>D1ygCzoD&k;G0qt3(o{*DW1x@$vvUEr6gyx&SGNf zV3}`V-oe_adRH%1w2w4>Z>Z2iz}}6s0IaEQevSP|?9XJ3CXrOTh7GbxuzMoz=}@E5 z?Ry;UX*6`iWR1oGYP+Y_I*h)zCu`tN2QcgE0Lm1BLBooy}Pg|CWt*_DKM5pSXFS$VCExvmUe|VWd<7EN0V&yBXq{+;wmzn=?rc>P{^MjOpX?5+I z^2cZ5zK^3`CV9E+u9)uGq={1AzjR7ny?H#|0_ju%Jl*g!(D6{a2XnaPrBcr}YS>W0 z__N@H2t($=iHPeufjg|6oB~-u{<1!EaiYZeU3tsZQC&L$>?T}})0@a8btI+mK||EFgz180(Wyl z;ynB{nY1L2B3$m^ZVhoxp@?eWM4_?r8_v)TW18at4UY}3leEVs@3OAMrI-Xc=F+px zdteVNZ6zNFNT8?i|CO3j3Xa^>P