diff --git a/doc/doxyfile b/doc/doxyfile index e53d875..ae5fd65 100644 --- a/doc/doxyfile +++ b/doc/doxyfile @@ -943,7 +943,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = main.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/doc/main.md b/doc/main.md old mode 100644 new mode 100755 index fb48070..79ccd00 --- a/doc/main.md +++ b/doc/main.md @@ -1,4 +1,9 @@ -EPANET OSS {#mainpage} -========== +EPANET Open-Source {#epanet_readme} +====== + +The EPANET Open-Source Library is a pressurized pipe network hydraulic and water quality analysis toolkit, originally developed by USEPA, written in C. + +__Note:__ This repository is not affiliated with, or endorsed by, the USEPA. For the "official" release of EPANET (2.00.12 UI and Toolkit) please go to the [EPA's GitHub repo](https://github.com/USEPA/Water-Distribution-Network-Model) or [the USEPA website](http://www2.epa.gov/water-research/epanet). It is also not the graphical user interface version. This is the hydraulic and water quality solver engine. + +However, if you are interested in extending EPANET for academic, personal, or commercial use, then you've come to the right place. For community discussion, FAQ, and roadmapping of the project, go to the [Community Forum](http://community.wateranalytics.org/category/epanet). -Most of the API documentation of interest in in epanet2.h \ No newline at end of file