From 3be3eceea303da95b0823e5151d1acc7da7ea7c0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebasti=C3=A1n=20Santisi?= <ssantisi@fi.uba.ar>
Date: Mon, 29 Jul 2024 21:39:48 +0000
Subject: [PATCH] Agrego README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5cf065d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Entorno Nix para compilar VASP
+
+Este entorno fue probado con la versión 5.4.1, los archivos están basados en
+esa versión en particular.
+
+Se provee la definición del entorno de compilación de Nix y el archivo de
+Makefile adaptado para reconocer las bibliotecas desde el entorno.
+
+## Compilación
+
+Reemplazar `Makefile.include` por el provisto en este repositorio.
+
+Ejecutar
+
+```
+nix-shell default.nix
+```
+
+para generar el entorno de compilación.
+
+Dentro del entorno de Nix ejecutar
+
+```
+make
+```
+
+para generar el proyecto.
+
+## Ejecución
+
+Los binarios quedan generados en el directorio `bin`.