From 17c0c482be828e09dede9dba2dc259e4b5fd9aa2 Mon Sep 17 00:00:00 2001
From: hchou10 <hchou10@illinois.edu>
Date: Wed, 1 Apr 2020 21:59:45 -0500
Subject: [PATCH] Add README.md

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1bb7368
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+This is a very small program for me to pre-compute potential file for ARBD simulation.
+This program generates corresponding potential Dx file when a density Dx file and the potential type is given.
+The supported potential type incudes 12-6 Lennard Jones, Debye-Huckel potential and tabulated potential.
+I partially realize the structure of C++ class structure and late-binding using C function pointer and preprocessing. 
+You have to install fftw3 in order to successfully compile the code.
+I also provide some small tool to manipulate the Dx file such as mult_grid (multiply a grid by a constant), slice_grid (slice outside voxels), sub_grid (subtract two grid values),
+sum_grid (sum two grids).
\ No newline at end of file
-- 
GitLab