From 22ff01e2a52e1f0a996b92e50fe9308b32ebfbc7 Mon Sep 17 00:00:00 2001 From: MatejMecka Date: Wed, 13 Dec 2017 17:18:16 +0100 Subject: [PATCH] Fix some stuff --- INSTALLATION.MD | 91 ++++++++++++++++++++----------------------------- README.md | 2 +- 2 files changed, 38 insertions(+), 55 deletions(-) diff --git a/INSTALLATION.MD b/INSTALLATION.MD index f7187b1a..f04eef8e 100644 --- a/INSTALLATION.MD +++ b/INSTALLATION.MD @@ -1,7 +1,15 @@ -# Linux +# Installation +CCExtractor runs on all major platforms and getting started and using it is easy! -### Installation +You can compile it on most platforms using CMake using the `CMakeLists.txt` file stored in `ccextractor/src` autoconf and build scripts designed specifically for your platform. + For how to install using those two methods you can check the short guide for your platform. + +There are also precompiled binaries for you too use. You can get them from [CCExtractor’s](https://www.ccextractor.org/?id=public:general:downloads) website + +### 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 @@ -13,13 +21,12 @@ 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 +*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. +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. @@ -31,11 +38,10 @@ You'll need to have autoconf installed using apt-get. After Installation you can now use CCExtractor. To use it call CCExtractor from the terminal by doing `./ccextractor ` -### GUI: +###### 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) -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 +In order to compile it you'll need to configure it using autoconf. The only difference passing the `-with-gui` option to `./configure`. @@ -43,25 +49,20 @@ In order to compile it you'll need to configure it using autoconf. The only diff Once set up you can run the GUI interface from the terminal `./ccextractorGUI` +--- +### Fedora -*** - -# Fedora - -### Installation - +###### 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 - +```### 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. +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. @@ -75,8 +76,7 @@ You'll need to have autoconf and automake installed using yum to generate config 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) +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`. @@ -84,12 +84,10 @@ In order to compile it you'll need to configure it using autoconf. The only diff Once set up you can run the GUI interface from the terminal `./ccextractorGUI` -*** - -# Mac - -### Installation +--- +### 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 @@ -108,11 +106,10 @@ pkg-config --exists --print-errors tesseract pkg-config --exists --print-errors lept ``` -### Setup - +###### 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. +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. @@ -124,8 +121,7 @@ There are 3 ways to set up ccextractor depending on your choice. After Installation you can now use CCExtractor. To use it call CCExtractor from the terminal by doing `./ccextractor ` -### GUI: - +###### 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: ``` @@ -139,30 +135,24 @@ In order to compile it you'll need to configure it using autoconf. The only diff Once set up you can run the GUI interface from the terminal `./ccextractorGUI` -*** - -# Windows - -### Installation +--- +### 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 are: `(Debug|Release)-Full` Configurations options include dependent libraries which are used for OCR. -*** - -# Building Installation Packages - -# Arch Linux +--- +## 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 - +--- +### Redhat Package Manager (rpm) based Linux Distributions Go to the package_creators folder using `cd` and run the `./rpm.sh` @@ -172,10 +162,3 @@ Go to the package_creators folder using `cd` and run the `./rpm.sh` - - - - - - - diff --git a/README.md b/README.md index 8f588843..a286f3e4 100644 --- a/README.md +++ b/README.md @@ -29,7 +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) -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. +To learn more about how to install CCExtractor for your platform check the [installation guide](INSTALLATION.MD). ## Support