Updated README

Makefile

@@ -11,8 +11,9 @@ DEBUG ?= 1
 # Configuration files path
 SRC_PATH=fpga/srcs
 
-DOC_OUTDIR         := doc/html
-DOC_SOURCES        := doc/Doxyfile
+DOC_OUTDIR    := doc/html
+DOXYGEN_FILE  := doc/Doxyfile
+DOC_SOURCES   := $(wildcard hdl/*.vhd) README.md
 
 # Targets
 .PHONY: all clean opendoc
@@ -24,16 +25,14 @@ doc: $(DOC_OUTDIR)/index.html
 
 # Documentation rules
 
-$(DOC_OUTDIR)/index.html: $(DOC_SOURCES)
+$(DOC_OUTDIR)/index.html: $(DOXYGEN_FILE) $(DOC_SOURCES)
 	@echo "\033[1;92mBuilding: $@\033[0m"
 	@mkdir -p $(DOC_OUTDIR)
-	@doxygen $^
+	@doxygen $<
 
 opendoc: $(DOC_OUTDIR)/index.html
-	nohup firefox $(DOC_OUTDIR)/index.html
+	nohup firefox $(DOC_OUTDIR)/index.html >> /dev/null
 
 clean:
 	@echo "\033[1;92mDeleting all generated files\033[0m"
 	@rm -rf $(DOC_OUTDIR)
-
-

README.md

@@ -1,6 +1,33 @@
 # ESS openEVR
 
-This is the very beginning of the ESS openEVR.
+ESS openEVR is a subset implementation of the MRF's Event Receiver. The project
+is based in the mrf-openEVR firmware, released by MRF in GitHub.
+
+The respository has been structured as an IP core which can be added from a
+top project using VIVADO. The current development targets the picoZED carrier
+board made by the Tallinn University of Technology as in-kind contribution to
+the ESS.
+
+**Still under heavy development.**
+
+If you'd like to request a feature, contact any of the maintainers working for
+the ESS.
+
+## Documentation
+
+The code is partitally commented using Doxygen syntax. In order to compile the
+documentation, Doxygen must be installed in the system, Make is also needed.
+
+To generate the docs, type:
+
+    $ make
+
+The script will try to open the generated files using Firefox.
+
+## Maintainers
+
+- Ross Elliot (ross.elliot@ess.eu)
+- Felipe Torres González (felipe.torresgonzalez@ess.eu)
 
 ## Credits
 

doc/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "ESS openEVR"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.1
+PROJECT_NUMBER         = 0.4
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -170,7 +170,7 @@ FULL_PATH_NAMES        = YES
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        = 
+STRIP_FROM_PATH        =
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which