Skip to content

Installation instructions in README.md #142

Closed

Description

@jbytecode

Due to the submission: JuliaCon/proceedings-review#202

It would be nice to have installation instructions in the README.md file of repository. I know, it has been mentioned in the documentation but an entry in the README like

Installation

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

and

julia> ]
(@v1.xx) pkg> add https://github.com/JuliaDynamics/StreamSampling.jl.git

with some descriptive text would be perfect.

Here is an example: https://github.com/jbytecode/OperationsResearchModels.jl/blob/main/README.md

Activity

  1. ameligrana commented on Apr 3, 2026

    @ameligrana
    Member

    thank you @jbytecode, added the instructions in the more or less same format you suggested

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions