Tested on Ubuntu 18.10
Cloned copperspice/doxypress
README has no instructions on how to build and instead sends me to DoxyPress docs: https://www.copperspice.com/docs/doxypress/build-doxypress.html
Six major dependencies are presented
| // Copyright John McFarlane 2018. | |
| // Distributed under the Boost Software License, Version 1.0. | |
| // (See accompanying file ../LICENSE_1_0.txt or copy at | |
| // http://www.boost.org/LICENSE_1_0.txt) | |
| // mechanically retrieved, single-header version of CNL library | |
| // https://github.com/johnmcfarlane/cnl | |
| #if ! defined(CNL_COMPLETE_H) |
| // Out of curiosity I took preprocessor_fun.h | |
| // https://gist.github.com/aras-p/6224951 | |
| // and added it to a project at work to see what happens when random C | |
| // preprocessor hacks are applied to a modern C++ project with CI. | |
| // Unfortunately, about half were flagged as warnings/errors by the compiler. | |
| // Almost all of the rest had no effect because the codebase uses too much | |
| // of the Standard Library / just doesn't use those APIs. | |
| // The only one which wasn't caught by static tools was __builtin_expect | |
| // which showed up as a failed death test. It is used in <gsl/gsl_assert> so | |
| // should cause a decent amount of consternation in GSL-dependent projects. |
I interpreted from Kona LEWG-I minutes that we're still exploring the design space. Specific work done by me for Cologne:
| #include "wwf_lexicon.h" | |
| namespace { | |
| node nAAHED = { | |
| "", | |
| nullptr, | |
| true | |
| }; | |
| node nAAHEe[] {nAAHED}; | |
| node nAAHE = { | |
| "D", |
| set -exu pipeline | |
| SCRIPT_DIR=$(cd "$(dirname "$0")"; pwd) | |
| PROJECT_DIR="$SCRIPT_DIR"/llvm-project | |
| mkdir -p build | |
| cd build | |
| cmake \ | |
| -GNinja \ | |
| -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \ |
| # 1 "<built-in>" | |
| # 1 "/home/john/ws/rounding-overflow/cnl/test/unit/scaled_integer/rounding/elastic/integer.cpp" | |
| // Copyright John McFarlane 2015 - 2016. | |
| // Distributed under the Boost Software License, Version 1.0. | |
| // (See accompanying file ../../LICENSE_1_0.txt or copy at | |
| // http://www.boost.org/LICENSE_1_0.txt) | |
| #if 0 /* expanded by -frewrite-includes */ | |
| #include <cnl/elastic_integer.h> |
| template <int c, long s> struct _; | |
| #if defined(__clang__) | |
| _<__clang_major__, __cplusplus> clang_version_and_standard; | |
| #elif defined(__GNUC__) | |
| _<__GNUC__, __cplusplus> gcc_version_and_standard; | |
| #elif defined(_MSC_VER) | |
| _<_MSC_VER, __cplusplus> msvc_version_and_standard; | |
| #else | |
| #error "I don't know that compiler" | |
| #endif |
| --2020-06-01 14:46:28-- http://upload.cppreference.com/mwiki/images/f/f8/cppreference-doxygen-web.tag.xml | |
| Resolving upload.cppreference.com (upload.cppreference.com)... 2604:4f00::3:0:1238:1, 74.114.90.46 | |
| Connecting to upload.cppreference.com (upload.cppreference.com)|2604:4f00::3:0:1238:1|:80... connected. | |
| HTTP request sent, awaiting response... 200 OK | |
| Length: 1100140 (1.0M) [application/xml] | |
| Saving to: ‘cppreference-doxygen-web.tag.xml’ | |
| cppreference-doxygen-web.tag.xml 100%[=====================================================================================================================>] 1.05M 853KB/s in 1.3s | |
| 2020-06-01 14:46:30 (853 KB/s) - ‘cppreference-doxygen-web.tag.xml’ saved [1100140/1100140] |
Different people have different views about what constitutes a good README document for a software project. I think it should be vehicle for delivery of the bare minimum knowledge necessary to convey why someone might want to use it and how.
Imagine you're a trainee who was given a URL to the GitHub page on your first day. You have only the bare resources needed to run the program, but none of the knowledge about it.
What information would you need? Make certain to add that information: