Skip to content

Commit 0264d8f

Browse files
Updating documentation.
1 parent e39f259 commit 0264d8f

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,5 +114,7 @@ See [References](https://connectivecpp.github.io/doc/references.html) for detail
114114

115115
# About
116116

117-
Team member information is [available here](https://connectivecpp.github.io/), and a few random author comments are [available here](doc/about.md).
117+
Team member information is [available here](https://connectivecpp.github.io/).
118+
119+
A few "Cliff Notes" are [available here](doc/cliff_notes.md).
118120

doc/about.md renamed to doc/cliff_notes.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Author Notes and Contributor Information
2-
31
## A Cliff Note on the Chops Name
42

53
>(from Cliff, 2018) Yes, the name / acronym is a stretch. Quite a stretch. I like the word "chops", which is a jazz term for strong technique, so I decided on that for a name. For example, "Check out Tal Wilkenfeld, she's got mad chops."

doc/release.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
## Release 1.0
44

5-
Release 1.0 is under development, expected in the first part of 2020. Additional platform and compiler testing is under way, in-depth tutorials are under development, and the marshalling library in the `utility-rack` repository needs to be completed.
5+
Release 1.0 is under development, expected in the first part of 2020. The functionality is already well tested under g++ and clang++ on Linux, MacOS, and Raspbian, but needs additional testing on other compilers and platforms including VC++ on Windows.
6+
7+
### Next Steps, ToDo's, Problems, and Constraints:
8+
9+
- The CMake files (CMakeLists.txts, etc) are working but enhancements and improvements are needed. CMake is relatively new for the Connective C++ team and enhancement requests are welcome.
10+
- Code coverage tools have not been used on the codebase.
11+
- The Doxygen annotation is mostly complete, but additional tutorial content is needed.
612

713
## Release 0.3
814

0 commit comments

Comments
 (0)