Skip to content

Commit

Permalink
Added comment that the Git Large File Storage client (git-lfs) is a '…
Browse files Browse the repository at this point in the history 
…clone time' dependency.
  • Loading branch information
@rljacobson
rljacobson committed Dec 18, 2018
1 parent 87b27ec commit ba10b5b
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
View file
Expand Up @@ -15,7 +15,7 @@ The term rewriting system and pattern matching engine is fairly advanced. The co

![Jupyter screenshot](/images/jupyter_screenshot.png)

(This screenshot demonstrates the Jupyter notebook interface for Expreduce. This Jupyter extension can be found [here](https://github.com/mmatera/iwolfram).)
This screenshot demonstrates the Jupyter notebook interface for Expreduce. This Jupyter extension can be found [here](https://github.com/mmatera/iwolfram).

# Install and run

Expand All @@ -24,9 +24,12 @@ The term rewriting system and pattern matching engine is fairly advanced. The co
If you just want to get started, you can download a binary release and run the software without any downloading Go or compiling. Head over to the [latest release](https://github.com/corywalker/expreduce/releases/latest) and download the correct package for your OS.

## From source

You must have the [Git Large File Storage](https://git-lfs.github.com/) client (`git-lfs`) installed before cloning the repository.

```
go get github.com/corywalker/expreduce
expreduce
$ go get github.com/corywalker/expreduce
$ expreduce
```

## Documentation
Expand Down Expand Up @@ -118,6 +121,7 @@ Also of interest is to build up some formal theory on the rule definitions. Ther
# Development

Pretty standard Go workflow. Just remember to `go generate`.

```
# To update any .m changes or changes to the parser:
go generate ./...
Expand Down

1 comment on commit ba10b5b

@rljacobson
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users who attempt to go get the repository without the Git Large File Storage client installed will clone git-lfs references instead of the required files. This manifests as a cryptic error message:

$ go get github.com/corywalker/expreduce
expreduce.go:14:2: 
expreduce/resources.go:1:1: expected 'package', found version

screen shot 2018-12-16 at 3 15 40 pm

I added a line explaining that git-lfs must be installed before cloning the repository.

I also added a newline and removed some parentheses—editorial suggestions that are immaterial to the issue this pull request resolves.

Please sign in to comment.