Adds further installation and usage instructions #52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #52 +/- ##
=======================================
Coverage 95.58% 95.58%
=======================================
Files 20 20
Lines 181 181
=======================================
Hits 173 173
Misses 8 8Continue to review full report at Codecov.
|
| @@ -17,7 +51,7 @@ image. The background and foreground will be automatically binarized. | |||
| Let's see a simple demo: | |||
|
|
|||
| ```@example | |||
| using TestImages, ImageBinarization, FileIO # hide | |||
There was a problem hiding this comment.
- using TestImages, ImageBinarization, FileIO # hide
+ using TestImages, ImageBinarization
+ using FileIO # hideFileIO isn't required to load test images.
There was a problem hiding this comment.
Thanks for the suggestion.
waldyrious
reviewed
Oct 28, 2019
docs/src/index.md
Outdated
| @@ -6,6 +6,40 @@ A Julia package containing a number of algorithms for analyzing images and autom | |||
| Depth = 2 | |||
| ``` | |||
|
|
|||
| ## Getting started | |||
| This package is part of a wider Julia-based image processing | |||
| [ecosystem](https://github.com/JuliaImages). If you are a starting out, then you | |||
There was a problem hiding this comment.
A small typo :)
Suggested change
| [ecosystem](https://github.com/JuliaImages). If you are a starting out, then you | |
| [ecosystem](https://github.com/JuliaImages). If you are starting out, then you |
waldyrious
reviewed
Oct 28, 2019
docs/src/index.md
Outdated
| already installed some key packages. Notably, it assumes that you are able to | ||
| load and display an image. Loading an image is facilitated through the | ||
| [FileIO.jl](https://github.com/JuliaIO/FileIO.jl) package, which uses | ||
| [QuartzImageIO.jl](https://github.com/JuliaIO/QuartzImageIO.jl) if you are on `MacOS`, and |
There was a problem hiding this comment.
Looks like this line needs to be re-wrapped.
waldyrious
reviewed
Oct 28, 2019
docs/src/index.md
Outdated
| of `MacOS` are [unable to use](https://github.com/JuliaImages/ImageView.jl/issues/175) the ImageView package. | ||
|
|
||
| As an alternative, one can display an image using the [Makie.jl](https://github.com/JuliaPlots/Makie.jl) plotting package. There is also the [ImageShow.jl](https://github.com/JuliaImages/ImageShow.jl) package which facilitates displaying images in `Jupyter` notebooks | ||
| via [IJulia.jl](https://github.com/JuliaLang/IJulia.jl). |
There was a problem hiding this comment.
The two paragraphs above don't seem to be wrapped correctly. There are some line breaks, but not at the same length (~80 characters) used in the rest of the added text.
Also increases TOC depth so that users can click on links that take them directky to the description of individual algorithms.
zygmuntszpak
force-pushed
the
getting_started_guide
branch
from
c248477 to
acff2f7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP to address the request outlined in #51