[IMPROVEMENT] Update README and add Installation file.#835
[IMPROVEMENT] Update README and add Installation file.#835canihavesomecoffee merged 3 commits intoCCExtractor:masterfrom MatejMecka:master
Conversation
Add INSTALLATION file and update README
|
|
||
| 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. |
There was a problem hiding this comment.
That link won't do. A wiki isn't good either. You can link to documents in the same repo, see the Sample platform for example.
| @@ -0,0 +1,181 @@ | |||
| # Linux | |||
There was a problem hiding this comment.
This lacks a good header, an overview to the available options and maybe an introduction.
| # 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 build scripts designed specifically for your platform. |
There was a problem hiding this comment.
This sentence doesn't sound very right
|
|
||
| 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 |
There was a problem hiding this comment.
Why jump in 2 levels?
| ``` | ||
| sudo yum install -y gcc | ||
| sudo yum install -y tesseract-devel | ||
| ```### Setup |
There was a problem hiding this comment.
This seems to be an error
| ```### 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. |
There was a problem hiding this comment.
Why not using headings with the names of the scripts?
|
|
||
| Configurations options include dependent libraries which are used for OCR. | ||
|
|
||
| --- |
There was a problem hiding this comment.
What's up with these lines?
There was a problem hiding this comment.
line break or separator
|
|
||
| cd ccextractor/package_creators | ||
| ./rpm.sh | ||
| To learn more about how to install CCExtractor for your platform check the [installation guide](INSTALLATION.MD). |
There was a problem hiding this comment.
I'd put this on top of this section, and remove the precompiled binaries section as that's also mentioned in the installation guide.
2 participants
Add INSTALLATION file and update README
Please prefix your pull request with one of the following: [FEATURE] [FIX] [IMPROVEMENT].
In raising this pull request, I confirm the following (please check boxes):
My familiarity with the project is as follows (check one):
Updated README and added an Installation file for offline users.