Skip to content

Commit 064d881

Browse files
authored
Update README.md
1 parent 14846d2 commit 064d881

1 file changed

Lines changed: 14 additions & 27 deletions

File tree

README.md

Lines changed: 14 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,25 @@
1-
# CFDModels_bundle
2-
Sorbents
3-
Validated 1MW Adsorber
4-
Filtered Models
5-
Attrition
6-
Pulverization
7-
Solvents
8-
VOF Wetted Surface
9-
Wetted Wall Column
1+
# CFDModels Bundle
102

11-
## Development Practices
3+
This is a convience bundle containing the following CCSI Toolset products:
124

13-
* Code development will be peformed in a forked copy of the repo. Commits will not be
14-
made directly to the repo. Developers will submit a pull request that is then merged
15-
by another team member, if another team member is available.
16-
* Each pull request should contain only related modifications to a feature or bug fix.
17-
* Sensitive information (secret keys, usernames etc) and configuration data
18-
(e.g database host port) should not be checked in to the repo.
19-
* A practice of rebasing with the main repo should be used rather that merge commmits.
5+
**Solvents:**
6+
- [VOF Wetted Surface](../../../vof_area_correlation)
7+
- [Wetted Wall Column](../../../WWC)
208

21-
## Getting Started
22-
23-
TBD
24-
25-
## Authors
9+
**Sorbents:**
10+
- [Attrition](../../../attrition)
11+
- [Filtered Models](../../../filtered_models)
12+
- [Pulverization](../../../Pulverization)
13+
- [Validated 1MW Adsorber](../../../1mw_cfd)
2614

27-
TBD
15+
You can download the entire [bundle](../../releases/latest) or follow the above links to the individual products.
2816

29-
See also the list of [contributors](https://github.com/CCSI-Toolset/CFDModels_bundle/contributors) who participated in this project.
17+
## Getting Started
18+
See installation and user guide documents in the [documentation](docs) subdirectory.
3019

3120
## Versioning
32-
3321
We use [SemVer](http://semver.org/) for versioning. For the versions available,
34-
see the [tags on this repository](https://github.com/CFDModels_bundle/tags).
22+
see the [releases](../../releases) or [tags](../../tags) on this repository.
3523

3624
## License & Copyright
37-
3825
See [LICENSE.md](LICENSE.md) file for details

0 commit comments

Comments
 (0)