Skip to content

Commit

Permalink
Add Dockerfile, fix Makefile, update README
Browse files Browse the repository at this point in the history
  • Loading branch information
torognes committed Jun 3, 2021
1 parent aede4df commit 4efd2c1
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 16 deletions.
3 changes: 3 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.dockerignore
.git
.gitignore
8 changes: 8 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
FROM alpine:3.13
WORKDIR /opt/compairr
COPY . .
RUN apk add --no-cache libstdc++ make g++ && \
make clean && make && make test && make install && make clean && \
apk del make g++
ENTRYPOINT ["/usr/local/bin/compairr"]
CMD ["--help"]
8 changes: 5 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Makefile
# Makefile for CompAIRR

PREFIX=/usr/local
ifndef PREFIX
PREFIX=/usr/local
endif

all : compairr

Expand All @@ -11,7 +13,7 @@ test: compairr
make -C test

install: compairr test
/usr/bin/install -c src/compairr $(PREFIX)/bin
/usr/bin/install -c src/compairr $(PREFIX)/bin/compairr

clean:
make -C src clean
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ adaptive immune receptor repertoires, or cluster the sequences in one
repertoire.


## Installation

The code is C++11 standard compliant and should compile easily using a
modern C++ compiler (e.g. GNU GCC or LLVM Clang). Run `make clean`,
`make`, `make test` or `make install` in the main folder to clean,
build, test or install the tool. It is no dependencies except for the
C standard library and the C++ standard libraries.

Binaries for Linux (x86_64) and macOS (x86_64 and ARM64) are also
distributed with each
[release](https://github.com/uio-bmi/compairr/releases/latest).

A `Dockerfile` is included if you want to make a Docker image.


## General options

Use the `-h` or `--help` option to show some help information.
Expand Down Expand Up @@ -273,15 +288,6 @@ with 1 or 2 substitutions or indels, the hashes of all these
'microvariants' are generated and looked up.


## Binaries

The code is C++11 standard compliant and should compile easily using a
modern C++ compiler. Run `make clean`, `make`, `make test` or `make
install` in the main folder to clean, build, test or install the
tool. Binaries for Linux and macOS are also distributed with each
release.


## Performance

As a preliminary performance test, Cohort 2 ("Keck") of
Expand Down Expand Up @@ -339,14 +345,14 @@ immune receptor repertoires allowing non-exact sequence matching.**
## Support

We will prioritize fixing important bugs. We will also try to answer
questions and implement suggested enhancements as time permits. As we
have no dedicated funding for this project we cannot make any
guarantees on the level of support.
questions, improve documentation and implement suggested enhancements
as time permits. As we have no dedicated funding for this project we
cannot make any guarantees on the level of support.

To report a potential bug, suggest enhancements or ask questions,
please use one of the following means:

* [Submit an issue on GitHub](https://github.com/uio-bmi/compairr/issues)
* [Submit an issue on GitHub](https://github.com/uio-bmi/compairr/issues) (preferred)

* Send an email to [`torognes@ifi.uio.no`](mailto:torognes@ifi.uio.no)

Expand Down

0 comments on commit 4efd2c1

Please sign in to comment.