[Proposal] Move the documentation to the wiki about tesseract-ocr-ios HOT 14 CLOSED

I like this idea for the community-driven documentation. Another project that it seems to have worked well for is the D3 Javascript library: https://github.com/mbostock/d3.

If @gali8 is cool with the move, it would be nice if the README had some quick links to parts of the wiki, for example the installation instructions, getting started, etc. as opposed to one coarse "see the wiki" link.

I also would not mind helping with the move and/or contributing more documentation.

from tesseract-ocr-ios.

Here's a list of Wiki articles I'd propose we start writing to migrate the documentation:

• Home/Welcome (maybe also Table of contents?)
• Installation
• Building Tesseract/Leptonica from source
• Getting started
• API reference
• Tips for improving the OCR result via various image preprocessing steps (see #42 and #76)
• Contributing (including a list of contributors)
• Old release notes (see below)

Regarding "Old release notes", really the release notes should just exist as the annotations for our releases on the GitHub's Releases page for this repo. Thus we could move all Release Notes that are currently in the README to an "Old release notes" Wiki page since I don't think we can add the annotations to those old releases now. Then all future releases should just have the annotations we would have put in the Release Notes section in the README.

Also the README would then look a lot smaller and mostly just have links to the articles in the Wiki.

@zachberger + anyone else, let me know if you have any thoughts about these topics or want to add more.

from tesseract-ocr-ios.

I think this is a great start, we can see if there are any gaps after the migration. I'm wrapping up finals this week, but could devote a bunch of time over the holiday break to doing some of this work.

I'm a big fan of GitHub releases; that should be sufficient.

from tesseract-ocr-ios.

Home page in Wiki is empty :(
Should we copy some info from readme file there?
And there is only one line about the project in the readme. What is the project? Why is this? How can it help developers? and so on. Perhaps, we could take some info from upstream Tesseract.

What do you also think about asking upstream tesseract holders to add the link to this project to their wiki? Here, for example: https://code.google.com/p/tesseract-ocr/wiki/3rdParty. There are 2 iOS projects already exist, but both are very old and one is a branch of G8 repo, actually, while another has tes 2 core.

from tesseract-ocr-ios.

We also could add reference to this repository on wiki page of Tesseract: wiki/Tesseract (software)

from tesseract-ocr-ios.

I've added a note to wiki: https://en.wikipedia.org/wiki/Tesseract_%28software%29.

from tesseract-ocr-ios.

Well done!

from tesseract-ocr-ios.

@ws233 cool!

As for the README, I think it's okay because we link to the relevant parts of the Wiki.

We should definitely add more info to the Wiki homepage. If my other note helps you edit Wiki pages, then feel free to get started on that.

And yeah, maybe when we finish the 4.0.0 release we can ask the upstream guys to add this project to their 3rd party wiki page.

from tesseract-ocr-ios.

I've written some info on Home page and added a topic related to Tesseract integrated thresholder bypassing here: https://github.com/gali8/Tesseract-OCR-iOS/wiki/Tips-for-Improving-OCR-Results
Could you take a look on this and correct my broken English or add something important, what I forgot to mention?

from tesseract-ocr-ios.

And I found that API is not documented at all. There are only methods without any descriptions. Is it a known issue?

from tesseract-ocr-ios.

It will be automatically updated when we release the cocoa pods update.
On Tue, Jan 6, 2015 at 1:51 PM Cyril [email protected] wrote:

And I found that API is not documented at all. There are only methods
without any descriptions. Is it a known issue?

Reply to this email directly or view it on GitHub
#64 (comment)
.

from tesseract-ocr-ios.

Thanks for your additions to the Wiki, @ws233. I improved the wording on them and a few other tweaks; let me know if you think it looks okay.

from tesseract-ocr-ios.

I think the last Wiki page that needs to be edited before we can close this issue is the Contributing page: https://github.com/gali8/Tesseract-OCR-iOS/wiki/Contributing

I'll find some good information to put in the "How to contribute" space and then close this issue. I'll work on this tonight.

from tesseract-ocr-ios.

I finally added instructions for the "How to contribute" section of the Wiki, so I'll go ahead and close this issue now.

from tesseract-ocr-ios.