Skip to content

Commit 9a86c9d

Browse files
authored
Merge pull request #275 from FourierFlows/ncc/update-readme
Update README
2 parents 2ec883e + 14e8118 commit 9a86c9d

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,12 @@ For more details refer to the [documentation](https://fourierflows.github.io/Fou
3737

3838
## Installation
3939

40-
To install, simply do
40+
To install, use Julia's built-in package manager to add the package and also to instantiate/build all the required dependencies
4141

4242
```julia
43-
] add FourierFlows
43+
julia> using Pkg
44+
julia> Pkg.add("FourierFlows")
45+
julia> Pkg.instantiate()
4446
```
4547

4648
The most recent version of FourierFlows.jl requires Julia v1.5 or later.
@@ -81,19 +83,44 @@ See also the child packages [GeophysicalFlows.jl][] for example usage of Fourier
8183
problems in Geophysical Fluid Dynamics.
8284

8385

86+
## Getting help
87+
88+
Interested in using FourierFlows.jl or trying to figure out how to use it? Please feel free
89+
to ask us questions and get in touch! The [documentation](https://fourierflows.github.io/FourierFlowsDocumentation/stable)
90+
is always the best place to start. Check out the [examples](https://github.com/FourierFlows/FourierFlows.jl/tree/master/examples) and [open an issue](https://github.com/FourierFlows/FourierFlows.jl/issues/new)
91+
or [start a discussion](https://github.com/FourierFlows/FourierFlows.jl/discussions/new)
92+
if you have any questions, comments, suggestions, etc.
93+
94+
8495
## Developers
8596

8697
FourierFlows is currently being developed by [Gregory L. Wagner][] (@glwagner)
8798
and [Navid C. Constantinou][] (@navidcy).
8899

89100

90-
## Cite
101+
## Citing
91102

92103
The code is citable via [zenodo](https://zenodo.org). Please cite as:
93104

94105
> Navid C. Constantinou & Gregory L. Wagner. (2021). FourierFlows/FourierFlows.jl: FourierFlows v0.6.17 (Version v0.6.17). Zenodo. [http://doi.org/10.5281/zenodo.1161724](http://doi.org/10.5281/zenodo.1161724)
95106
96107

108+
109+
## Contributing
110+
111+
We are excited to get more people involved in contributing to the development of FourierFlows.jl!
112+
We welcome any contribution, no matter how big or small! It's always great to have new people
113+
look at the code with fresh eyes: you will see errors that other developers have missed.
114+
115+
Let us know by [open an issue](https://github.com/FourierFlows/FourierFlows.jl/issues/new)
116+
or [start a discussion](https://github.com/FourierFlows/FourierFlows.jl/discussions/new)
117+
if you'd like to work on a new feature or implement a new module, if you're new to open-source
118+
and want to find a cool little project or issue to work on that fits your interests! We're more
119+
than happy to help along the way.
120+
121+
For more information, check out our [contributor's guide](https://github.com/FourierFlows/FourierFlows.jl/blob/master/CONTRIBUTING.md).
122+
123+
97124
[Julia]: https://julialang.org/
98125
[Navid C. Constantinou]: http://www.navidconstantinou.com
99126
[Gregory L. Wagner]: https://glwagner.github.io

0 commit comments

Comments
 (0)