diff --git a/INSTALLATION.MD b/INSTALLATION.MD new file mode 100644 index 00000000..f7187b1a --- /dev/null +++ b/INSTALLATION.MD @@ -0,0 +1,181 @@ +# Linux + +### Installation + +In Order to install CCExtractor you need to have the following libraries installed: `gcc,tesseract-ocr,tesseract-orc-dev,libleptonica-dev,libcurl4-gnutils-dev` + +You can install them using apt-get or paste this in your terminal +``` +sudo apt-get install -y gcc +sudo apt-get install -y libcurl4-gnutls-dev +sudo apt-get install -y tesseract-ocr +sudo apt-get install -y tesseract-ocr-dev +sudo apt-get install -y libleptonica-dev +``` + +**Note:** On Ubuntu Version 14.04 (Trusty) and earlier, you should build leptonica and tesseract from source + +### Setup + +There are 3 ways to set up ccextractor depending on your choice. + +1. First and easiest way is to go in the linux folder and use the build script. +`cd linux && ./build` + +2. Standard linux compilation through Autoconf scripts. +You'll need to have autoconf installed using apt-get. +`./autogen.sh && ./configure && make` + +3. Using Cmake. +`mkdir build && cd build; cmake ../src/ && make` + +After Installation you can now use CCExtractor. To use it call CCExtractor from the terminal by doing `./ccextractor ` + +### GUI: + +To use CCExtractor with a gui you will additionally need to install [GLEW](http://glew.sourceforge.net/build.html) and [GLFW](http://www.glfw.org/docs/latest/compile.html) + +In order to compile it you'll need to configure it using autoconf. The only difference passing the `-with-gui` option to + +`./configure`. + +`./autogen.sh && ./configure --with-gui && make` + +Once set up you can run the GUI interface from the terminal `./ccextractorGUI` + + +*** + +# Fedora + +### Installation + +In Order to install CCExtractor you need to have the following libraries installed: `gcc,tesseract-devel` Don't worry tesseract-devel comes default with leptonica + +You can install them using yum or paste this in your terminal +``` +sudo yum install -y gcc +sudo yum install -y tesseract-devel +``` +### Setup + +There are 3 ways to set up ccextractor depending on your choice. + +1. First and easiest way is to go in the linux folder and use the build script. +`cd linux && ./build` + +2. Standard linux compilation through Autoconf scripts. +You'll need to have autoconf and automake installed using yum to generate configuration script. + +`./autogen.sh && ./configure && make` + +3. Using Cmake. +`mkdir build && cd build; cmake ../src/ && make` + +After Installation you can now use CCExtractor. To use it call CCExtractor from the terminal by doing `./ccextractor ` + +### GUI: + +To use CCExtractor with a gui you will additionally need to install [GLEW](http://glew.sourceforge.net/build.html) and [GLFW](http://www.glfw.org/docs/latest/compile.html) + +In order to compile it you'll need to configure it using autoconf. The only difference passing the `-with-gui` option to `./configure`. + +`./autogen.sh && ./configure --with-gui && make` + +Once set up you can run the GUI interface from the terminal `./ccextractorGUI` + +*** + +# Mac + +### Installation + +In Order to install CCExtractor on your MacOS device you need to have the following libraries installed: `pkg-config, autoconf,automake, libtool, tesseract, leptonica` + +You can install them using homebrew or paste this in your terminal + +``` +brew install pkg-config +brew install autoconf automake libtool +brew install tesseract +brew install leptonica +``` + +To verify that leptonica and tesseract are succesfully installed run pkg-config to check for errors. You can test by using this command: + +``` +pkg-config --exists --print-errors tesseract +pkg-config --exists --print-errors lept +``` + +### Setup + +There are 3 ways to set up ccextractor depending on your choice. + +1. First and easiest way is to go in the mac folder and use the build script. +`cd mac && ./build.command` + +2. Standard linux compilation through Autoconf scripts. + +`./autogen.sh && ./configure && make` + +3. Using Cmake. +`mkdir build && cd build; cmake ../src/ && make` + +After Installation you can now use CCExtractor. To use it call CCExtractor from the terminal by doing `./ccextractor ` + +### GUI: + +To use CCExtractor with a gui you will additionally need to install GLEW and GLFW. You can do that by installing it via homebrew using: + +``` +brew install glfw +brew install glew +``` + +In order to compile it you'll need to configure it using autoconf. The only difference passing the `-with-gui` option to `./configure`. + +`./autogen.sh && ./configure --with-gui && make` + +Once set up you can run the GUI interface from the terminal `./ccextractorGUI` + +*** + +# Windows + +### Installation + +Open the windows/ccextractor.sln file with Visual Studio (2015 at least), and build it. + +Configurations options are: `(Debug|Release)-Full` + +Configurations options include dependent libraries which are used for OCR. + +*** + +# Building Installation Packages + +# Arch Linux + +Go to the package_creators folder using `cd` and run the `./arch.sh` + +*** + +# Redhat Package Manager (rpm) based Linux Distributions + +Go to the package_creators folder using `cd` and run the `./rpm.sh` + + + + + + + + + + + + + + + diff --git a/README.md b/README.md index a76e3eff..8f588843 100644 --- a/README.md +++ b/README.md @@ -29,227 +29,7 @@ More usage information can be found on our website: - [Using the command line tool](https://www.ccextractor.org/doku.php?id=public:general:command_line_usage) - [Using the Windows GUI](https://www.ccextractor.org/doku.php?id=public:general:win_gui_usage) -You can also find the list of parameters and their brief description by running `ccextractor` without any arguments. - -## Compiling CCExtractor (without GUI) - -You may compile CCExtractor across all major platforms using `CMakeLists.txt` stored under `ccextractor/src/` directory. Simply, - -1. Create and navigate to directory where you want to store built files - -``` -cd ccextractor/ -mkdir build -cd build -``` - -2. Generate makefile using cmake and then compile - -``` -cmake ../src/ -make -``` - -You may also generate `.sln` files for Visual Studio and build using build tools, or open `.sln` files using Visual Studio. - -``` -cmake ../src/ -G "Visual Studio 14 2015" -cmake --build . --config Release --ccextractor -``` - ---- - -CCExtractor can also be compiled without cmake. System specific instructions are listed below : - -Clone the latest repository from Github - -``` -git clone https://github.com/CCExtractor/ccextractor.git -``` - -### Debian/Ubuntu - -1. Make sure all the dependencies are met. - -``` -sudo apt-get install -y gcc -sudo apt-get install -y libcurl4-gnutls-dev -sudo apt-get install -y tesseract-ocr -sudo apt-get install -y tesseract-ocr-dev -sudo apt-get install -y libleptonica-dev - -# Note: On Ubuntu Version 14.04 (Trusty) and earlier, you should build leptonica and tesseract from source -``` - -2. Compiling - -*Using build script :* - -``` -#Navigate to linux directory and call the build script - -cd ccextractor/linux -./build - -# test your build -./ccextractor -``` - -*Standard linux compilation through Autoconf scripts :* - -``` -sudo apt-get install autoconf #Dependency to generate configuration script -cd ccextractor/linux -./autogen.sh -./configure -make - -# test your build -./ccextractor -``` - -### Fedora - -1. Make sure all the dependencies are met. - -``` -sudo yum install -y gcc -sudo yum install -y tesseract-devel # leptonica will be installed automatically -``` - -2. Compiling - -*Using build script :* - -``` -#Navigate to linux directory and call the build script - -cd ccextractor/linux -./build - -# test your build -./ccextractor -``` - -*Standard linux compilation through Autoconf scripts :* - -``` -sudo dnf install autoconf automake #Dependency to generate configuration script -cd ccextractor/linux -./autogen.sh -./configure -make - -# test your build -./ccextractor -``` - -### MacOS - -1. Make sure all the dependencies are met. They can be installed via Homebrew as - -``` -brew install pkg-config -brew install autoconf automake libtool -brew install tesseract -brew install leptonica -``` - -Make sure tesseract and leptonica are detected by pkg-config, e.g. - -```` -pkg-config --exists --print-errors tesseract -pkg-config --exists --print-errors lept -```` - -2. Compiling - -*Using build.command script :* - -``` -cd ccextractor/mac -./build.command OCR -``` -If you don't want the OCR capabilities, then you don't need to configure the tesseract and leptonica packages, and build it with just -``` -cd ccextractor/mac -./build.command -``` - -*Standard compilation through Autoconf scripts :* - -``` -cd ccextractor/mac -./autogen.sh -./configure -make -``` - - -### Windows - -Open the windows/ccextractor.sln file with Visual Studio (2015 at least), and build it. Configurations "(Debug|Release)-Full" includes dependent libraries which are used for OCR. - -## Compiling CCExtractor (with GUI) - -### Linux - -1. Make sure all the dependencies are met.
- * Build GLEW from source, instructions [here](http://glew.sourceforge.net/build.html) - * Build GLFW from source, instructions [here](http://www.glfw.org/docs/latest/compile.html) - -2. Compiling - - -``` -cd ccextractor/linux -./autogen.sh -./configure --with-gui -make - -# test your build -./ccextractorGUI -``` - - -### MacOS - -1. Make sure all the dependencies are met. They can be installed via Homebrew as - -``` -brew install glfw -brew install glew -``` - -2. Compiling - -``` -cd ccextractor/mac -./autogen.sh -./configure --with-gui -make -``` - - -### Windows - -Open the windows/ccextractor.sln file with Visual Studio (2015 at least), and build it. Configurations "(Debug|Release)-Full" includes dependent libraries which are used for OCR. - -## Building Installation Packages - -### Arch Linux - -*building installation package (.pkg.tar.xz) or installing directly* - - cd ccextractor/package_creators - ./arch.sh - -### Redhat Package Manager (rpm) based Linux Distributions - -*building installation package (.rpm)* - - cd ccextractor/package_creators - ./rpm.sh +To learn more about how to install CCExtractor for your platform check the INSTALLATION.MD file or visit the wiki and choose the operating system you want to do so or click [here](https://github.com/MatejMecka/ccextractor/wiki) to go there. ## Support