Skip to content

Add installation instructions to README #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ameligrana merged 1 commit into from
Apr 3, 2026
Merged

Add installation instructions to README #144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,29 @@ This has some advantages over other sampling procedures:

For information about the available functionalities consult the [documentation](https://juliadynamics.github.io/StreamSampling.jl/stable/).

## Installation

To install the package you can do

```julia
julia> ]
(@v1.xx) pkg> add StreamSampling
```

or

```julia
julia> using Pkg
julia> Pkg.add("StreamSampling")
```

If you want to install the latest source that is not registered yet, you can instead do

```julia
julia> using Pkg
julia> Pkg.develop("StreamSampling")
```

## Contributing

Contributions are welcome! If you encounter any issues, have suggestions for improvements, or would like to add new
Expand Down
Loading