Skip to content

Commit

Permalink
Update README installation instructions for 1.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim Walsh committed Jan 10, 2017
1 parent ce5883c commit 5baf4c4
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 15 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2017 Tim Walsh

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Brunnhilde - A reporting companion to Siegfried

### Version: Brunnhilde 1.3.1
### Version: Brunnhilde 1.4.0

Generates aggregate reports of files in a directory or disk image based on input from Richard Lehane's [Siegfried](http://www.itforarchivists.com/siegfried).

Expand Down Expand Up @@ -32,22 +32,10 @@ For a more detailed explanation of how multiple identifications are handled by S

### Installation

#### Install in Linux:
Clone or download Brunnhilde repository and extract to location of your choice (for use with Brunnhilde GUI, it is recommended to extract files to /usr/share/brunnhilde).
`sudo pip install brunnhilde`

#### Install in macOS/OS X with Homebrew:
`brew install timothyryanwalsh/digipres/brunnhilde`
Once installed, you can call brunnhilde with just `brunnhilde.py [arguments]`.

Once installed, you can call Brunnhilde on your Mac with just `brunnhilde.py [arguments]`.

To upgrade from a previous version of Brunnhilde:
`brew update && brew upgrade timothyryanwalsh/digipres/brunnhilde`

#### Usage in Bitcurator with the Brunnhilde GUI:
* Create directory /usr/share/brunnhilde:
`sudo mkdir /usr/share/brunnhilde`
* Move brunnhilde.py to /usr/share/brunnhilde:
`sudo mv /path/to/brunnhilde.py /usr/share/brunnhilde`

### Usage

Expand Down

0 comments on commit 5baf4c4

Please sign in to comment.