Skip to content

Commit 0494d16

Browse files
Update README.md
1 parent 94f642d commit 0494d16

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
11
# EmacsComStrip
22
CLI Based Comment Stripper Using Emacs
3+
4+
5+
Emacs has excelent language scemantics processing and also has a batch mode to allow execution of lisp code in a headless fashion.
6+
7+
This tool allows the user to use emacs to strip source code comments from any source langage.
8+
9+
## usage:
10+
``` emacs --file=<path_to_source_code> --quick --batch --eval '(load "./comstrip.lisp")' ```
11+
12+
This tool will read in <source_code>, use emacs to strip comments out and the write to /tmp/<file_name>_comstrip
13+
14+
## Requirements:
15+
* emacs
16+
* language files for languages that need processing
17+
18+
Note: This code is presently written for *nix but can easily be updated to be x-platform. This is my first `lisp` program so still in the early stages.
19+

0 commit comments

Comments
 (0)