ww5 created page: build instructions authored by Wieselquist, William's avatar Wieselquist, William
...@@ -26,7 +26,7 @@ With those definitions in mind, let's define a set of word conventions. The main ...@@ -26,7 +26,7 @@ With those definitions in mind, let's define a set of word conventions. The main
* regex: ``<FREEFUNC>``=``<LCAMEL>`` * regex: ``<FREEFUNC>``=``<LCAMEL>``
* conventions: try to use a verb as the first word, e.g. countListElements instead of listElementCount * conventions: try to use a verb as the first word, e.g. countListElements instead of listElementCount
4. namespace component (``NAME``) 4. namespace component (``NAME``)
* description: simple lower case name which if in two parts means ``organization::component`` * description: simple, one-word lower case
* regex: ``<NAME>``=``<LWORD>``, !``detail``,!``tst``,!``example`` * regex: ``<NAME>``=``<LWORD>``, !``detail``,!``tst``,!``example``
* eg: ``scale``, ``origen``, ``polaris``, ``nemesis`` * eg: ``scale``, ``origen``, ``polaris``, ``nemesis``
* special: * special:
...@@ -34,6 +34,7 @@ With those definitions in mind, let's define a set of word conventions. The main ...@@ -34,6 +34,7 @@ With those definitions in mind, let's define a set of word conventions. The main
* use ``tst`` for unit tests (possibly not pretty) * use ``tst`` for unit tests (possibly not pretty)
* use ``example`` for an example usage (should be pretty) * use ``example`` for an example usage (should be pretty)
5. fully qualified namespace (``NAMESPACE``) 5. fully qualified namespace (``NAMESPACE``)
* description: a complete namespace which should have one or two main parts, if two, the standard is ``organization::component``. Special final namespaces can be used to hide implementation details, testing code, and group example usage.
* regex: ``<NAME>(::<NAME>)?(::detail|::tst|::example)?`` * regex: ``<NAME>(::<NAME>)?(::detail|::tst|::example)?``
* e.g. ``scale::io``,``origen::detail``,`` origen::tst``,``origen::example``,``ornl::gtest::example`` * e.g. ``scale::io``,``origen::detail``,`` origen::tst``,``origen::example``,``ornl::gtest::example``
6. typedef or variant class name (``CLASSTYPE``) 6. typedef or variant class name (``CLASSTYPE``)
...@@ -45,9 +46,3 @@ With those definitions in mind, let's define a set of word conventions. The main ...@@ -45,9 +46,3 @@ With those definitions in mind, let's define a set of word conventions. The main
* description: in style of the STL library, should be templated * description: in style of the STL library, should be templated
* regex: ``<LIBFUNC>``=``<SNAKE>`` * regex: ``<LIBFUNC>``=``<SNAKE>``
[Build Instructions](Build-instructions)
[Vision Documents](Vision-documents)
[Feature Documents](Feature-documents)