commit 0ab3fbcd66d5316ae09cd95b00bb7ccdaa9818f7 Spenser Truex <truex@equwal.com> 2025-09-04 23:47:58 -0700 Markdown README
README | 45 --------------------------------------------- README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 45 deletions(-)
diff --git a/README b/README deleted file mode 100644 index 476e3f0..0000000 --- a/README +++ /dev/null @@ -1,45 +0,0 @@ -Generate tags for a list of files and extensions. - -=== -Requirements -=== -- A Common Lisp. ECL, SBCL, and CLISP are fine. -- a tagging program like etags or ctags - -=== -Install -=== - -Run make in this folder. - -Edit the config/ files with the paths you want tagged. Read the docs -for your tag program to know how to tell it what languages to use. - -Add a command to cron like: -*/29 * * * * su username -c 'tag-gen.sh /path/to/tag-gen/local.conf /usr/bin/etags 1' -*/29 * * * * su root -c 'tag-gen-root.sh /path/to/tag-gen/root.conf /usr/bin/etags 1' -for routine tagging. - -Signature: - - -tags.conf needs to contain this kind of format: - -"/path/to/ctags/program" - -(("<directory>" ("<ext>"...)) - ...) -See examples in config-examples. Configuration is **mandatory** for the -program to work. The format is just read with the lisp reader. - -For example: -(("/home/jose/.emacs.d" ("el")) - ("/home/jose/src/sf/sbcl/sbcl" ("lisp" "c"))) - -Keep in mind that the home shorthand ~ might not git expanded -properly! Always use absolute paths like in the examples. - -For output control, call with a debug argument 0, 1, 2 where: -- 0 is silent -- 1 is for serious errors -- 2 is for everything diff --git a/README.md b/README.md new file mode 100644 index 0000000..64f9c4f --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +Generate tags for a list of files and extensions. + +# Requirements +- An ANSI Common Lisp +- A ctags-like program. + +# Install + +Run make in this folder. + +Edit the config/ files with the paths you want tagged. Read the docs for your tag program to know how to tell it what languages to use. + +Add a command to cron like: +``` +*/29 * * * * su username -c 'tag-gen.sh /path/to/tag-gen/local.conf /usr/bin/etags' +*/29 * * * * su root -c 'tag-gen-root.sh /path/to/tag-gen/root.conf /usr/bin/etags' +``` +for routine tagging. + +tags.conf needs to contain this kind of format: +``` +"/path/to/ctags/program" + +(("<directory>" ("<ext>"...)) + ...) +``` +See examples in config-examples. Configuration is **mandatory** for the program to work. The format is just read with +the lisp reader and is very simple.