From ae055e86f0d76dc798014f7d0e766022d798139c Mon Sep 17 00:00:00 2001 From: Travis Askham Date: Fri, 30 Mar 2018 18:42:27 -0700 Subject: [PATCH] update readme and require files more info on installation and added a required package to require --- README.md | 12 ++++++++++-- REQUIRE | 3 ++- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 63c5dcb..2877e0c 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,18 @@ This repository contains an implementation of a robust version of the dynamic mode decomposition (DMD) in julia. +## Install + +You can install this package with + +> Pkg.clone("https://github.com/UW-AMO/RobustDMD.jl.git") + +or a particular version by modifying the url. + ## Requirements -The examples require the Munkres package. Otherwise the -library is self-contained. +The examples require the Munkres package and will work on +julia v0.5 and later. Otherwise the library is self-contained. > Pkg.add("Munkres") diff --git a/REQUIRE b/REQUIRE index 2fbd684..24c49c4 100644 --- a/REQUIRE +++ b/REQUIRE @@ -1 +1,2 @@ -julia 0.5 \ No newline at end of file +julia 0.5 +Munkres \ No newline at end of file