mirror of
https://github.com/CCExtractor/ccextractor.git
synced 2026-02-04 05:44:53 +00:00
Add compilation section to readme and improve instructions. (#836)
Also moved remaining .md files in docs.
This commit is contained in:
Saurabh Shrivastava
committed by
Carlos Fernandez Sanz
Carlos Fernandez Sanz
parent
f78303abef
commit
0b31e5d7a1
193
INSTALLATION.MD
193
INSTALLATION.MD
@@ -1,193 +0,0 @@
|
||||
# Installation
|
||||
CCExtractor runs on all major platforms and getting started and using it is easy!
|
||||
|
||||
You can compile it on most platforms using CMake using the `CMakeLists.txt` file stored in `ccextractor/src`
|
||||
|
||||
Autoconf and custom build scripts are also available.
|
||||
|
||||
For instructions on how to install CCExtractor using them is available in the section 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:
|
||||
|
||||
```
|
||||
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.
|
||||
|
||||
#### Using the Build script
|
||||
|
||||
First and easiest way is to go in the linux folder and use the build script.
|
||||
|
||||
`cd linux && ./build`
|
||||
|
||||
#### Using autoconf
|
||||
|
||||
Standard linux compilation through Autoconf scripts.
|
||||
You'll need to have autoconf installed using apt-get.
|
||||
`./autogen.sh && ./configure && make`
|
||||
|
||||
#### Using Cmake
|
||||
|
||||
Create a build folder in ccextractor and make from `src`.
|
||||
|
||||
`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 <file>`
|
||||
|
||||
### 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.
|
||||
|
||||
#### Using the Build script
|
||||
|
||||
First and easiest way is to go in the linux folder and use the build script.
|
||||
|
||||
`cd linux && ./build`
|
||||
|
||||
#### Using autconf
|
||||
|
||||
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`
|
||||
|
||||
#### Using Cmake
|
||||
|
||||
Create a build folder in ccextractor and make from `src`.
|
||||
|
||||
`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 <file>`
|
||||
|
||||
### 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.
|
||||
|
||||
#### Using the Build script
|
||||
|
||||
First and easiest way is to go in the mac folder and use the build script.
|
||||
|
||||
`cd mac && ./build.command`
|
||||
|
||||
#### Using autoconf
|
||||
|
||||
Standard linux compilation through Autoconf scripts.
|
||||
|
||||
`./autogen.sh && ./configure && make`
|
||||
|
||||
#### Using Cmake
|
||||
|
||||
Create a build folder in ccextractor and make from `src`.
|
||||
|
||||
`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 <file>`
|
||||
|
||||
### 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`
|
||||
|
||||
19
README.md
19
README.md
@@ -14,19 +14,26 @@ CCExtractor has been invited to Code-in 2017! A second year of challenging tasks
|
||||
|
||||
If you are a student fitting the age criteria, then you most likely are eligible to participate. Read more at the [Google Code-in website](https://codein.withgoogle.com).
|
||||
|
||||
## Installation
|
||||
|
||||
To learn more about how to install CCExtractor for your platform check the [installation guide](INSTALLATION.MD).
|
||||
## Installation and Usage
|
||||
|
||||
Downloads for precompiled binaries and source code can be found [on our website](https://www.ccextractor.org?id=public:general:downloads).
|
||||
|
||||
## Usage
|
||||
|
||||
Extracting subtitles is relatively simple. Just run the following command:
|
||||
|
||||
```ccextractor <input>```
|
||||
|
||||
This will extract the subtitles.
|
||||
This will extract the subtitles.
|
||||
|
||||
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
|
||||
|
||||
To learn more about how to compile and build CCExtractor for your platform check the [compilation guide](docs/COMPILATION.MD).
|
||||
|
||||
## Support
|
||||
|
||||
|
||||
205
docs/COMPILATION.MD
Normal file
205
docs/COMPILATION.MD
Normal file
@@ -0,0 +1,205 @@
|
||||
# Compiling CCExtractor
|
||||
|
||||
You may compile CCExtractor across all major platforms using `CMakeLists.txt` stored under `ccextractor/src/` directory. Autoconf and custom build scripts are also available. See platform specific instructions in the below sections.
|
||||
|
||||
Downloads for precompiled binaries and source code can be found [on our website](https://www.ccextractor.org?id=public:general:downloads).
|
||||
|
||||
Clone the latest repository from Github
|
||||
|
||||
```
|
||||
git clone https://github.com/CCExtractor/ccextractor.git
|
||||
```
|
||||
|
||||
## Linux
|
||||
|
||||
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 the 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
|
||||
```
|
||||
|
||||
**Using Cmake**
|
||||
|
||||
```
|
||||
#Create and navigate to directory where you want to store built files
|
||||
|
||||
cd ccextractor/
|
||||
mkdir build
|
||||
cd build
|
||||
|
||||
#Generate makefile using cmake and then compile
|
||||
|
||||
cmake ../src/
|
||||
make
|
||||
|
||||
# test your build
|
||||
./ccextractor
|
||||
```
|
||||
|
||||
|
||||
**Compiling with GUI:**
|
||||
|
||||
To build 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 by passing the `-with-gui` option.
|
||||
|
||||
```
|
||||
./autogen.sh
|
||||
./configure --with-gui
|
||||
make
|
||||
```
|
||||
|
||||
Once set up you can run the GUI interface from the terminal `./ccextractorGUI`
|
||||
nterface from the terminal `./ccextractorGUI`
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
To verify 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
|
||||
|
||||
# test your build
|
||||
./ccextractor
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
# test your build
|
||||
./ccextractor
|
||||
```
|
||||
|
||||
**Using Cmake**
|
||||
|
||||
```
|
||||
#Create and navigate to directory where you want to store built files
|
||||
|
||||
cd ccextractor/
|
||||
mkdir build
|
||||
cd build
|
||||
|
||||
#Generate makefile using cmake and then compile
|
||||
|
||||
cmake ../src/
|
||||
make
|
||||
|
||||
# test your build
|
||||
./ccextractor
|
||||
```
|
||||
|
||||
**Standard compilation through Autoconf scripts :**
|
||||
|
||||
```
|
||||
cd ccextractor/mac
|
||||
./autogen.sh
|
||||
./configure
|
||||
make
|
||||
|
||||
# test your build
|
||||
./ccextractor
|
||||
```
|
||||
|
||||
**Compiling with 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 by passing the `-with-gui` option.
|
||||
|
||||
```
|
||||
./autogen.sh
|
||||
./configure --with-gui
|
||||
make
|
||||
```
|
||||
|
||||
Once set up you can run the GUI interface from the terminal `./ccextractorGUI`
|
||||
|
||||
## Windows
|
||||
|
||||
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.
|
||||
|
||||
**Using Cmake**
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
## 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`
|
||||
|
||||
Reference in New Issue
Block a user