Merge pull request #5 from bijujacob/master

Updates for OS release

HFGP.acmf

@@ -36,12 +36,7 @@ References
 
 Modified by Juan Morinelly, September 2012: Initialization procedure variables and equations inclusion
 
-This Material was produced under the DOE Carbon Capture Simulation Initiative (CCSI), and copyright is held by the software owners: ORISE, LANS,
-LLNS, LBL, PNNL, CMU, WVU, et al. The software owners and/or the U.S. Government retain ownership of all rights in the CCSI software and the
-copyright and patents subsisting therein. Any distribution or dissemination is governed under the terms and conditions of the CCSI Test and
-Evaluation License, CCSI Master Non-Disclosiure Agreement, and the CCSI Intellectual Property Management Plan. No rights are granted except as
-expressly recited in one of the aforementioned agreements.
-
+See LICENSE.md for license and copyright details
 
 ...Kayode Ajayi (2015)
 // Pressure drop model was included in the shell side of the membrane. It was based on Hagen-Posiellie equation  by introducing
@@ -371,20 +366,14 @@ References
 
 Modified by Juan Morinelly, September 2012: Initialization procedure variables and equations inclusion
 
-
-
 Modified by Kayode Ajayi (2015)
 // Pressure drop model was included in the shell side of the membrane. It was based on Hagen-Posiellie equation  by introducing
    hydraulic diameter (Daejun Chang, Joonho MIn, Sehern Oh, Kilo Moon, Effect of Pressure Drop on performance of Hollow membrane model for gas permeation,
    Koren J. Chemg. Eng., 15(4), (1998), 396-403.
   Li-Hua Cheng, Ping-Chung Wu, Junghui Chen, Modelling and optimisation of hollow fiber DCMD module for desalination, Journal of Membernae Science, 154 (2008),
   154-166
 
-This Material was produced under the DOE Carbon Capture Simulation Initiative (CCSI), and copyright is held by the software owners: ORISE, LANS,
-LLNS, LBL, PNNL, CMU, WVU, et al. The software owners and/or the U.S. Government retain ownership of all rights in the CCSI software and the
-copyright and patents subsisting therein. Any distribution or dissemination is governed under the terms and conditions of the CCSI Test and
-Evaluation License, CCSI Master Non-Disclosiure Agreement, and the CCSI Intellectual Property Management Plan. No rights are granted except as
-expressly recited in one of the aforementioned agreements.
+  See LICENSE.md for license and copyright details.
 
 */
 //===============================================================================================================================================================

Makefile

@@ -6,9 +6,10 @@ LICENSE    := LICENSE.md
 PKG_DIR    := CCSI_$(PROD_SNAME)_$(VERSION)
 PACKAGE    := $(PKG_DIR).zip
 
-PAYLOAD := README.md \
-	HFGP.acmf \
-	$(LICENSE)
+PAYLOAD := 	docs/*.pdf \
+			README.md \
+			HFGP.acmf \
+			$(LICENSE)
 
 # Get just the top part (not dirname) of each entry so cp -r does the right thing
 PAYLOAD_TOPS := $(sort $(foreach v,$(PAYLOAD),$(shell echo $v | cut -d'/' -f1)))

README.md

@@ -1,31 +1,33 @@
-# membrane_model
+# Membrane Model
 **Membrane Separation Model:** - Updated hollow fiber membrane model and system example for carbon capture.
 
-## Development Practices
-
-* Code development will be peformed in a forked copy of the repo. Commits will not be 
-  made directly to the repo. Developers will submit a pull request that is then merged
-  by another team member, if another team member is available.
-* Each pull request should contain only related modifications to a feature or bug fix.  
-* Sensitive information (secret keys, usernames etc) and configuration data 
-  (e.g database host port) should not be checked in to the repo.
-* A practice of rebasing with the main repo should be used rather that merge commmits.
+Note: This product is also part of the [Process Models Bundle](../../../ProcessModels_bundle)
 
 ## Getting Started
 
-TBD
+See installation and user guide documents in the [documentation](./docs) subdirectory.
 
 ## Authors
 
 * Kayode Ajayi
 * Debangsu Bhattacharyya
 
-See also the list of [contributors](https://github.com/CCSI-Toolset/membrane_model/contributors) who participated in this project.
+See also the list of [contributors](../../contributors) who participated in this project.
+
+## Development Practices
+
+* Code development will be performed in a forked copy of the repo. Commits will not be 
+  made directly to the repo. Developers will submit a pull request that is then merged
+  by another team member, if another team member is available.
+* Each pull request should contain only related modifications to a feature or bug fix.  
+* Sensitive information (secret keys, usernames etc.) and configuration data 
+  (e.g. database host port) should not be checked in to the repo.
+* A practice of rebasing with the main repo should be used rather than merge commits.
 
 ## Versioning
 
 We use [SemVer](http://semver.org/) for versioning. For the versions available, 
-see the [tags on this repository](https://github.com/CCSI-Toolset/membrane_model/tags). 
+see the [releases](../../releases) or [tags](../../tags) for this repository. 
 
 ## License & Copyright