Docker working

Author: qdm12

.travis.yml

@@ -3,5 +3,5 @@ services:
   - docker
 install:
   - docker build .
-#after_script:
-#  - "curl -X POST https://hooks.microbadger.com/images/qmcgaw/"
+after_script:
+  - "curl -X POST https://hooks.microbadger.com/images/qmcgaw/homomorphic-binary-circuits/5_ZQZ6uhRXvjJSJ9A6pWjfh0x2M="

Dockerfile

@@ -1,8 +1,8 @@
 FROM debian:stretch-slim
 LABEL maintainer="[email protected]" \
-      description="" \
-      download="MB" \
-      size="MB" \
+      description="Homomorphic binary operations such as binary comparisons or binary divisions using the library HElib" \
+      download="372.7MB" \
+      size="1230MB" \
       ram="Depends" \
       cpu_usage="Depends" \
       github="https://github.com/qdm12/hbc"
@@ -32,14 +32,23 @@ RUN GMP_V=6.1.2 && \
 	wget -q https://github.com/shaih/HElib/archive/master.tar.gz && \
 	tar -xzf master.tar.gz && \
 	rm master.tar.gz && \
-	mkdir -p /hbc/HElib/src /hbc/src /hbc/temp && \
-	mv HElib-master/src/* /hbc/HElib/src/ && \
-	rm -r HElib-master && \
-	cd /hbc/HElib/src && \
+	mkdir /HElibSrc && \
+	mv /HElib-master/src/* /HElibSrc/ && \
+	rm -r /HElib-master && \
+	cd /HElibSrc && \
 	make && \
 	make check && \
+	rm -rf Test_* *.o && \
 	apt-get remove wget ca-certificates bzip2 -qq > /dev/null && \
 	apt-get autoremove -qq > /dev/null && \ 
 	rm -rf /var/lib/apt/lists/*
-VOLUME /hbc/src
-WORKDIR /hbc
+VOLUME /hbc
+WORKDIR /hbc
+ENTRYPOINT rm -rf /hbc/HElib/src && \
+		   mkdir -p /hbc/HElib/src && \
+		   mv /HElibSrc/* /hbc/HElib/src/ && \
+		   make && \
+		   printf "\n\n === Build successful === \n\n" && \
+		   printf "\n 1) You can recompile your program with 'make'\n" && \
+		   printf "\n 2) Run your program with './hbc'\n\n" && \
+		   /bin/bash

README.md

@@ -17,15 +17,6 @@
 [![](https://images.microbadger.com/badges/image/qmcgaw/homomorphic-binary-circuits.svg)](https://microbadger.com/images/qmcgaw/homomorphic-binary-circuits)
 [![](https://images.microbadger.com/badges/version/qmcgaw/homomorphic-binary-circuits.svg)](https://microbadger.com/images/qmcgaw/homomorphic-binary-circuits)
 
-This project concerns the research and development of a real-use application of homomorphic encryption for cloud computing. 
-The application takes advantage of the various possibilities and limitations of present homomorphic encryption schemes and 
-programming libraries to remain usable in terms of time. The foundations of the application rely on the design of binary 
-operations using homomorphic encryption. All the binary logic gates and various binary blocks were developed and adapted 
-to provide enough functionalities to the application. The project focuses on providing features to cloud computing such as 
-calculating averages on large amounts of encrypted numbers in a relatively short and decent time. The result is an application 
-program interface written in C++ allowing to perform various operations on integers. It thus shows homomorphic encryption can 
-be used today for simple operations if the security is more important than the speed of execution. 
-
 - Written in C++
 - Cross-platform using either:
 	- Docker (see [Dockerfile](https://github.com/qdm12/hbc/blob/master/Dockerfile))
@@ -38,6 +29,8 @@ be used today for simple operations if the security is more important than the s
 
 *This project was developed as my Master thesis at Imperial College London.*
 
+This project concerns the research and development of a real-use application of homomorphic encryption for cloud computing. The application takes advantage of the various possibilities and limitations of present homomorphic encryption schemes and programming libraries to remain usable in terms of time. The foundations of the application rely on the design of binary operations using homomorphic encryption. All the binary logic gates and various binary blocks were developed and adapted to provide enough functionalities to the application. The project focuses on providing features to cloud computing such as calculating averages on large amounts of encrypted numbers in a relatively short and decent time. The result is an application program interface written in C++ allowing to perform various operations on integers. It thus shows homomorphic encryption can be used today for simple operations if the security is more important than the speed of execution. 
+
 ## 1. Your own code
 
 - By default, [*src/main.cpp*](https://github.com/qdm12/hbc/blob/master/src/main.cpp) runs all the unit tests of the project
@@ -57,21 +50,21 @@ Requirements:
 - An internet connection
 
 1. Install Docker (from [here](https://www.docker.com/community-edition))
-1. Place the src directory from the hbc repository in `/yoursrcpath` in example
-1. Place the *makefile* from the hbc repository in `/yourmakefilepath` in example
+1. Place the **makefile** and the **src** directory from the hbc repository (or the whole repo) in `/yourpath` in example
 1. Enter the following command in your terminal:
 
 	```bash
-	docker run -it --rm -v /yoursrcpath:/hbc/src -v /yourmakefilepath/makefile:/hbc/makefile qmcgaw/homomorphic-binary-circuits
+	docker run -it --rm -v /yoursrcpath:/hbc qmcgaw/homomorphic-binary-circuits
 	```
 
-	This will download the Docker image and mount the makefile and source files in the Docker container.
+	This downloads the Docker image (the first time), mount the makefile and source files in the Docker container,
+	compile your source code and run the compiled program. You can stop the execution with CTRL+C.
 
 1. Edit the makefile and/or source files on your host machine
 1. Enter `make` in the Docker container to re-build the binary hbc
-1. Run the executable in the Docker container with `/hbc/hbc`
-1. To quit the Docker container and delete it, simply exit with `exit`
-	
+1. Run the executable in the Docker container with `./hbc` or even on your host
+1. To quit the Docker container and delete it, simply enter `exit`
+
 ### 2.2. Vagrant
 
 ![Docker](https://github.com/qdm12/hbc/raw/master/readme/vagrant.png)
@@ -247,7 +240,7 @@ In a terminal on your host machine, enter:
 docker image rm qmcgaw/homomorphic-binary-circuits
 ```
 
-Then delete the hbc/src directory on your host machine
+Then delete the hbc repository on your host machine
 
 ### 5.1 With Vagrant
 
@@ -257,7 +250,7 @@ In a terminal on your host machine, enter:
 vagrant destroy
 ```
 
-Then delete the hbc/src directory on your host machine
+Then delete the hbc repository on your host machine
 
 ### 5.2 Otherwise
 

makefile

@@ -80,8 +80,7 @@ deepclean :
 	rm -f /usr/local/include/gmp.h
 	rm -f /usr/local/lib/libgmp.*
 	rm -f /usr/local/lib/libntl.*
-	rm -fr HElib
-	rm -fr src
+	rm -fr HElib src docs readme .dockerignore .gitignore .travis.yml README.md Dockerfile Vagrantfile
 
 help : 
 	@echo make hbc - Compiles the project source code into an executable "hbc"