Skip to content

Commit 8d6b234

Browse files
authored
Updating README.md (#383)
1 parent 675e6a4 commit 8d6b234

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,14 @@ At the core of Dagger.jl is a scheduler heavily inspired by [Dask](https://docs.
1717

1818
## Installation
1919

20-
You can install Dagger by typing
20+
Dagger.jl can be installed using the Julia package manager. Enter the Pkg REPL mode by typing "]" in the Julia REPL and then run:
2121

2222
```julia
23-
julia> ] add Dagger
23+
pkg> add Dagger
24+
```
25+
Or, equivalently, via the Pkg API:
26+
```julia
27+
julia> import Pkg; Pkg.add("Dagger")
2428
```
2529

2630
## Usage
@@ -37,6 +41,34 @@ b = Dagger.@spawn rand(a, 4)
3741
c = Dagger.@spawn sum(b)
3842
fetch(c) # some number!
3943
```
44+
## Contributing Guide
45+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
46+
[![GitHub issues](https://img.shields.io/github/issues/JuliaParallel/Dagger.jl)](https://github.com/JuliaParallel/Dagger.jl/issues)
47+
[![GitHub contributors](https://img.shields.io/github/contributors/JuliaParallel/Dagger.jl)](https://github.com/JuliaParallel/Dagger.jl/graphs/contributors)
48+
49+
Contributions are encouraged.
50+
51+
There are several ways to contribute to our project:
52+
53+
**Reporting Bugs**: If you find a bug, please open an issue and describe the problem. Make sure to include steps to reproduce the issue and any error messages you receive regarding that issue.
54+
55+
**Fixing Bugs**: If you'd like to fix a bug, please create a pull request with your changes. Make sure to include a description of the problem and how your changes will address it.
56+
57+
Additional examples and documentation improvements are also very welcome.
58+
59+
## Resources
60+
List of recommended Dagger.jl resources:
61+
- Docs [![][docs-master-img]][docs-master-url]
62+
- Videos
63+
- [Distributed Computing with Dagger.jl](https://youtu.be/capjmjVHfMU)
64+
- [Easy, Featureful Parallelism with Dagger.jl](https://youtu.be/t3S8W6A4Ago)
65+
- [Easier parallel Julia workflow with Dagger.jl](https://youtu.be/VrqzOsav61w)
66+
- [Dagger.jl Development and Roadmap](https://youtu.be/G0Y62ysFbDk)
67+
68+
## Help and Discussion
69+
For help and discussion, we suggest asking in the following places:
70+
71+
[Julia Discourse](https://discourse.julialang.org/c/domain/parallel/34) and on the [Julia Slack](https://julialang.org/slack/) in the `#distributed` channel.
4072

4173
## Acknowledgements
4274

0 commit comments

Comments
 (0)