From 34abdc09e5368eb46b88b0e248eb8b73c88d15b3 Mon Sep 17 00:00:00 2001 From: EugeneManushkin Date: Mon, 21 Sep 2020 21:43:12 +0300 Subject: [PATCH] Modified README.md --- README.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 138996c..8f6c9cd 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,18 @@ Yalta is a [ctags](https://en.wikipedia.org/wiki/Ctags)-like program that produces tags for source code files written in [Lua](https://www.lua.org/). This is an experimental program made as a PoC for pool request to [Universal Ctags](https://ctags.io/). +# Integrate with CtagsSourceNavigator +This utility may be integrated with [CtagsSourceNavigator](https://github.com/EugeneManushkin/CtagsSourceNavigator) plugin. +Download latest stable version from [releases](https://github.com/EugeneManushkin/Yalta/releases) page and unpack it. Open [Far Manager](https://www.farmanager.com/) +and then open plugin configuration page (**F11->Ctags Source Navigator->C Plugin configuration**). Uncheck "Use built in ctags utility" and put +full path to ctags_wrapper.bat script located in unpacked_release_folder\yalta\ctags_wrapper.bat. + # Install ### Windows Download latest stable version from [releases](https://github.com/EugeneManushkin/Yalta/releases) page. ## Linux Build it from source code. See Build section. -# Build -Required CMake and compiler with C++11 support. -```bash -git clone https://github.com/EugeneManushkin/Yalta.git yalta -mkdir -p yalta/build && cd yalta/build -cmake -DCMAKE_BUILD_TYPE=Release .. -cmake --build . -``` - # Usage ## Windows ```batch @@ -29,6 +26,15 @@ yalta.bat path/to/directory > tags ## Linux TODO: describe +# Build +Required CMake and compiler with C++11 support. +```bash +git clone https://github.com/EugeneManushkin/Yalta.git yalta +mkdir -p yalta/build && cd yalta/build +cmake -DCMAKE_BUILD_TYPE=Release .. +cmake --build . +``` + # What is captured? Unlike the Universal Ctags Yalta recognizes language constructions separated with spaces, line breaks and comments.