Skip to content

Commit

Permalink
link name to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shashi authored Aug 13, 2020
1 parent 72d2c33 commit 5853c54
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# FileTrees
# <a href="http://shashi.biz/FileTrees.jl">FileTrees</a>

[![Build Status](https://travis-ci.org/shashi/FileTrees.jl.svg?branch=master)](https://travis-ci.org/shashi/FileTrees.jl) [![Build status](https://ci.appveyor.com/api/projects/status/6sei8e7et721usx6?svg=true)](https://ci.appveyor.com/project/shashi/filetrees-jl)
[![Coverage Status](https://coveralls.io/repos/github/shashi/FileTrees.jl/badge.svg?branch=master)](https://coveralls.io/github/shashi/FileTrees.jl?branch=master)
Expand All @@ -13,6 +13,7 @@ Easy everyday parallelism with a file tree abstraction.
- Make up a file tree in memory, create some data to go with each file (in parallel), write the tree to disk (in parallel). (See example below)
- Virtually `mv` and `cp` files within trees, merge and diff trees, apply different functions to different subtrees. ([docs](http://shashi.biz/FileTrees.jl/tree-manipulation/))

[Go to the documentation &rarr;](http://shashi.biz/FileTrees.jl)

## Example

Expand All @@ -33,10 +34,10 @@ end

# map over the values to create an image at each node.
# 300x300 tile per image.
t1 = FileTrees.mapvalues(tree) do params
t1 = FileTrees.mapvalues(tree, lazy=true) do params
mandelbrot(50, params..., 300) # zoom level, moveX, moveY, size
end

# save it
@time FileTrees.save(t1) do file
FileIO.save(path(file), file.value)
Expand Down

2 comments on commit 5853c54

@shashi
Copy link
Owner Author

@shashi shashi commented on 5853c54 Aug 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/19444

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 5853c54d1049320c86d935cab51c8f2377a85f1b
git push origin v0.1.0

Please sign in to comment.