Skip to content

Commit 8ba1878

Browse files
authored
Merge pull request #4 from bijujacob/master
Updates for OS release
2 parents a2396f5 + b5e0210 commit 8ba1878

5 files changed

Lines changed: 18 additions & 35 deletions

Makefile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ LICENSE := LICENSE.md
66
PKG_DIR := CCSI_$(PROD_SNAME)_$(VERSION)
77
PACKAGE := $(PKG_DIR).zip
88

9-
PAYLOAD := README.md \
10-
HeatCalc.bkp \
11-
$(LICENSE)
9+
PAYLOAD := docs/*.pdf \
10+
README.md \
11+
HeatCalc.bkp \
12+
$(LICENSE)
1213

1314
# Get just the top part (not dirname) of each entry so cp -r does the right thing
1415
PAYLOAD_TOPS := $(sort $(foreach v,$(PAYLOAD),$(shell echo $v | cut -d'/' -f1)))

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,32 @@
22
**Solvent Crossflow Heat Exchanger Calculator:**
33
A Process model in Aspen Plus to optimize the size of the heat exchangers and their log-mean temperature difference (LMTD) to minimize capital and operating expenses.
44

5-
## Development Practices
6-
7-
* Code development will be peformed in a forked copy of the repo. Commits will not be
8-
made directly to the repo. Developers will submit a pull request that is then merged
9-
by another team member, if another team member is available.
10-
* Each pull request should contain only related modifications to a feature or bug fix.
11-
* Sensitive information (secret keys, usernames etc) and configuration data
12-
(e.g database host port) should not be checked in to the repo.
13-
* A practice of rebasing with the main repo should be used rather that merge commmits.
5+
Note: This product is also part of the [Process Models Bundle](../../../ProcessModels_bundle)
146

157
## Getting Started
168

17-
TBD
9+
See installation and user guide documents in the [documentation](./docs) subdirectory.
1810

1911
## Authors
2012

2113
* Brent Sherman
2214

23-
See also the list of [contributors](https://github.com/CCSI-Toolset/SolventCrossflowHX/contributors) who participated in this project.
15+
See also the list of [contributors](../../contributors) who participated in this project.
16+
17+
## Development Practices
18+
19+
* Code development will be performed in a forked copy of the repo. Commits will not be
20+
made directly to the repo. Developers will submit a pull request that is then merged
21+
by another team member, if another team member is available.
22+
* Each pull request should contain only related modifications to a feature or bug fix.
23+
* Sensitive information (secret keys, usernames etc.) and configuration data
24+
(e.g. database host port) should not be checked in to the repo.
25+
* A practice of rebasing with the main repo should be used rather than merge commits.
2426

2527
## Versioning
2628

2729
We use [SemVer](http://semver.org/) for versioning. For the versions available,
28-
see the [tags on this repository](https://github.com/CCSI-Toolset/SolventCrossflowHX/tags).
30+
see the [releases](../../releases) or [tags](../../tags) for this repository.
2931

3032
## License & Copyright
3133

695 KB
Binary file not shown.
444 KB
Binary file not shown.

jenkins_description.html

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)