iv-org-mirror/shard-ameba
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-ameba.git synced 2024-08-15 00:53:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Extend installation instructions (#19)

Browse source
This commit is contained in:
V. Elenhaupt 2017-11-14 20:52:15 +02:00 committed by GitHub
parent 198d024782
commit 413e2ec0fe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -27,6 +27,8 @@ Is still under construction, compatibility may be broken :construction:
## Installation ## Installation
### As a project dependency:
Add this to your application's `shard.yml`: Add this to your application's `shard.yml`:
```yaml ```yaml
@ -35,8 +37,21 @@ development_dependencies:
github: veelenga/ameba github: veelenga/ameba
``` ```
That will compile and install `ameba` binary onto your system. Compile and install `ameba` binary onto your system while running `crystal deps`.
### OS X
```
$ brew tap veelenga/tap
$ brew install ameba
```
### From sources
```
$ git clone https://github.com/veelenga/ameba && cd ameba
$ make install
```
Or just compile it from sources `make install`. Or just compile it from sources `make install`.
## Usage ## Usage