Skip to content

Commit

Permalink
initial version of vocr
Browse files Browse the repository at this point in the history
  • Loading branch information
srirangav committed Apr 20, 2022
1 parent 472e531 commit 1a442fe
Show file tree
Hide file tree
Showing 10 changed files with 8,607 additions and 2 deletions.
27 changes: 27 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Makefile
.DS_Store
# Xcode
build/
*.pbxuser
!default.pbxuser
*.mode1v3
!default.mode1v3
*.mode2v3
!default.mode2v3
*.perspectivev3
!default.perspectivev3
*.xcworkspace
!default.xcworkspace
xcuserdata
profile
*.moved-aside
DerivedData
.idea/
*.o
*.dSYM
*.orig
autom4te.cache
*~
*.log
*.status
*.zip
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Copyright (c) 2022 Sriranga Veeraraghavan <[email protected]>.
All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

42 changes: 42 additions & 0 deletions Makefile.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Makefile.in for vocr

PREFIX = @prefix@
PGM_SRCS = vocr.m
PGM = @PACKAGE_NAME@
PGM_REL = @PACKAGE_VERSION@
PGM_MAN = $(PGM).1
PGM_BINDIR = $(DESTDIR)$(PREFIX)/bin
PGM_MANDIR = $(DESTDIR)$(PREFIX)/man/man1
PGM_FILES = $(PGM_SRCS) $(PGM_MAN) Makefile README.txt LICENSE.txt

OBJC = @OBJC@
CFLAGS=@OBJCFLAGS@
LIBS=@LIBS@
INSTALL=@INSTALL@

# rules

all:
$(OBJC) $(CFLAGS) -o $(PGM) $(PGM_SRCS) $(LIBS)

.PHONY: distclean
distclean: clean
/bin/rm -f Makefile config.log config.status
/bin/rm -rf ./autom4te.cache ./$(PGM).dSYM

.PHONY: clean
clean:
/bin/rm -f *.o *~ core .DS_Store $(PGM) $(PGM).1.txt *.tgz

# install and uninstall rules
# from: http://nuclear.mutantstargoat.com/articles/make/#writing-install-uninstall-rules

.PHONY: install
install: $(PGM)
mkdir -p $(PGM_BINDIR) $(PGM_MANDIR)
$(INSTALL) $(PGM) $(PGM_BINDIR)/$(PGM)
$(INSTALL) -m 0644 $(PGM_MAN) $(PGM_MANDIR)/$(PGM_MAN)

.PHONY: uninstall
uninstall:
rm $(PGM_BINDIR)/$(PGM) $(PGM_MANDIR)/$(PGM_MAN)
2 changes: 0 additions & 2 deletions README.md

This file was deleted.

73 changes: 73 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
README
------

vocr v0.1.0
By Sriranga Veeraraghavan <[email protected]>

vocr is a MacOSX command line program that can perform optical
character recognition (OCR) on images and PDF files. It outputs
any text found in the input files to stdout. vocr relies on
Apple's Vision framework to perform OCR (hence its name v - for
[V]ision - and ocr - for [o]ptical [c]haracter [r]ecognition).

Usage:

vocr [-i [no|tab]] [-p] [-q] [files]

If -i is specified with the 'no' option, vocr will not attempt
to indent any text that is OCR'ed. If -i is specified with the
'tab' option, vocr will indent using tabs instead of spaces (by
default vocr indents using spaces).

If -p is specified, when OCR'ing a PDF, a page break (^L) will
be inserted at the end of each page.

If -q is specified, vocr runs in [q]uiet mode and only outputs
text found in the input files (all errors and informational
message are silenced).

Build:

$ ./configure
$ make

Install:

$ ./configure
$ make
$ make install

By default, vocr is installed in /usr/local/bin. To install
it in a different location, the alternate installation PREFIX
can be supplied to make as follows:

$ make install PREFIX="<prefix>"

For example, the following will install vocr in /opt/local:

$ make PREFIX=/opt/local install

A DESTDIR can also be specified for staging purposes (with or
without an alternate prefix):

$ make DESTDIR="<destdir>" [PREFIX="<prefix>"] install

Dependencies:

vocr relies on Apple's Vision framework, introduced in MacOSX
10.13 (High Sierra):

https://developer.apple.com/documentation/vision?language=objc

History:

v0.1.0 - initial release

Platforms:

vocr has been tested on MacOSX 11 (BigSur) on M1.

License:

See LICENSE.txt

Loading

0 comments on commit 1a442fe

Please sign in to comment.