Skip to content

Commit

Permalink
[skip ci] Add installation and license to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
giordano committed Jul 19, 2019
1 parent 5bf2590 commit ab92fb6
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,24 @@ most notable application of custom indices is probably the
Other use cases of custom indices are shown in [this blog
post](https://julialang.org/blog/2017/04/offset-arrays).

## Installation

The latest version of `RandomBasedArrays.jl` is available for Julia v1.0 and
later releases, and can be installed with [Julia built-in package
manager](https://julialang.github.io/Pkg.jl/stable/). In a Julia session, after
entering the package manager mode with `]`, run the command

```julia
pkg> add RandomBasedArrays
```


## Usage

```julia
julia> using RandomBasedArrays
julia> A = RandomBasedArray(reshape(1:25, 5, 5))
julia> A = RandomBasedArray(reshape(collect(1:25), 5, 5))
5×5 Array{Int64,2}:
15 7 4 2 6
7 10 10 9 18
Expand Down Expand Up @@ -144,3 +156,8 @@ julia> A
Fortran-like arrays with arbitrary, zero or negative starting indices
* [`TwoBasedIndexing.jl`](https://github.com/simonster/TwoBasedIndexing.jl):
Two-based indexing

## License

The `RandomBasedArrays.jl` package is licensed under the MIT "Expat" License.
The original author is Mosè Giordano.

2 comments on commit ab92fb6

@giordano
Copy link
Owner Author

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/2127

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 Julia TagBot is installed, or can be done manually through the github interface, or via:

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

Please sign in to comment.