RubyGems - ceedling - Versions diffs - 1.0.1 → 1.1.1 - Mend

ceedling 1.0.1 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1266) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bbf250a1b600bd7d3e3e281975f5ee3563e5052d5cd12de6840c717d18243cf
-  data.tar.gz: 62dfcf6c896792802c3405aa4faddc4d406339616dd2ef8e8f0b2fb6a2a147f1
+  metadata.gz: 56f073ff96051065c1f390744785a8e933cbfa700d81a585495b49d44b318f1c
+  data.tar.gz: 3d9567c9ebb1477eb215fb9cb8cdfd42f76b7b8c5cdfd9cce1010eff89e49ea3
 SHA512:
-  metadata.gz: 4d8f98451d2369c8a308bd89f7c036b69246c4d14f9124c4e264ffc19d090589de5f81dc94b77179a165e2929a7e826975a92736ddda00ea9508251607f573c8
-  data.tar.gz: 24187bf1b4cdb0fd559fcb705f68bd6c2220801aa7ae814662d196f6caa57b8ab2601fb042daed7db7933998610e1007bb7937a6b92c77e0ddfa7d2e1eb22044
+  metadata.gz: 3e108e84bc09d28d53ca336b49cea22e970d6319810b8b68dab3f1dadb9793eb40948589fb771f8f1d6f731ce2319f9ee32b9cc8a12a8f54d32061e4a052c948
+  data.tar.gz: 6e21e05a55622e2836e52feccd2db2c99a2827db4c6b1179f6ed30c702db8a59dc888fd460d23976d07b3c36237e400b0e553ee9493b3f287456bd10099eae29

data/GIT_COMMIT_SHA CHANGED Viewed

	@@ -1 +1 @@
1	- ~~fb1ce6c~~
1	+ e7770cc

data/Gemfile CHANGED Viewed

@@ -20,5 +20,11 @@ gem "diy", "~> 1.1"
 gem "constructor", "~> 2"
 gem "thor", "~> 1.3"
 gem "deep_merge", "~> 1.2"
+# `erb` & `benchmark` have been removed from the default gems in some Ruby versions Ceedling supports.
+# These must be declared explicitly for plain `gem install` (non-Bundler) users to successfully span supported Ruby versions.
+gem "erb", ">= 2.2"
+gem "benchmark", ">= 0.3"
 gem "unicode-display_width", "~> 3.1"
-gem "erb", "~> 4.0"
+gem "parallel", "~> 1.26"

data/Gemfile.lock CHANGED Viewed

@@ -1,44 +1,51 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    benchmark (0.5.0)
     constructor (2.0.0)
     deep_merge (1.2.2)
-    diff-lcs (1.5.1)
+    diff-lcs (1.6.2)
     diy (1.1.2)
       constructor (>= 1.0.0)
+    erb (2.2.0)
+    parallel (1.28.0)
     rake (13.2.1)
     require_all (3.0.0)
-    rr (3.1.1)
-    rspec (3.13.0)
+    rr (3.1.2)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    thor (1.3.2)
-    unicode-display_width (3.1.2)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
+    rspec-support (3.13.7)
+    thor (1.5.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 PLATFORMS
+  arm64-darwin
   ruby
   x64-mingw-ucrt
   x64-mingw32
-  x86_64-darwin-22
+  x86_64-darwin
   x86_64-linux
 DEPENDENCIES
+  benchmark (>= 0.3)
   bundler (~> 2.5)
   constructor (~> 2)
   deep_merge (~> 1.2)
   diy (~> 1.1)
+  erb (>= 2.2)
+  parallel (~> 1.26)
   rake (>= 12, < 14)
   require_all
   rr

data/README.md CHANGED Viewed

@@ -1,11 +1,41 @@
 Ceedling ![CI](https://github.com/ThrowTheSwitch/Ceedling/workflows/CI/badge.svg)
 ========
-Welcome to **Ceedling 1.0.1**
-See the [Release Notes](docs/ReleaseNotes.md) for an overview
-of all that’s new since 0.31.1 plus links to the detailed Changelog and list of
-Breaking Changes.
+**Ceedling 1.1.0** is the latest and greatest.
+See [_Release Notes_][release-notes], [_Changelog_](docs/Changelog.md),
+[_Breaking Changes_][breaking-changes], and [_Known Issues_][known-issues].
+See [🚀 Getting Started](#-getting-started) for installation and new
+project set up.
+**New goodies:**
+* A [Partial][partials-docs] allows a test to mix mocked and real functions
+from the same source module in a single test file and enables testing of
+`static` and `inline` functions without modifying source code.
+* Ceedling is now complemented by a full, searchable [documentation site][ceedling-docs-site]
+  available both online and as a local bundle exported from Ceedling’s
+  command line.
+* A new [Discourse community forum](https://throwtheswitch.discourse.group) to
+  supersede the old, spammy Google Group and handful of disparate support channels.
+* More and expanded [example projects][example-projects].
+* New stock plugins for [Valgrind memory checking][valgrind-plugin] and
+[Cppcheck static analysis][cppcheck-plugin].
+* The [GCov plugin][gcov-plugin]:
+   * _Finally_ supports coverage reports for all sources.
+   * Adds support for Modified Condition / Decision Coverage.
+* Mixins improvements including an option for [inline YAML at the command line][mixins-inline-yaml].
+* Ceedling’s test preprocessing is once again compatible with Unity’s
+  parameterized test cases (support was temporarily removed with 1.0.0).
+* Incorporates the latest updates to [CMock] and [Unity].
+[partials-docs]: https://throwtheswitch.github.io/Ceedling/1.1.0/testing-guide/partials/
+[example-projects]: https://throwtheswitch.github.io/Ceedling/latest/getting-started/example-projects/
+[ceedling-docs-site]: https://throwtheswitch.github.io/Ceedling/
+[valgrind-plugin]: https://throwtheswitch.github.io/Ceedling/1.1.0/plugins/valgrind/
+[cppcheck-plugin]: https://throwtheswitch.github.io/Ceedling/1.1.0/plugins/cppcheck/
+[gcov-plugin]: https://throwtheswitch.github.io/Ceedling/1.1.0/plugins/gcov/
+[mixins-inline-yaml]: https://throwtheswitch.github.io/Ceedling/latest/configuration/mixins/?h=mixins#-mixin-command-line-flags
 # 🌱 Ceedling is a handy-dandy build system for C projects
@@ -14,16 +44,28 @@ Breaking Changes.
 Ceedling can build your release artifact but is especially adept at building
 unit test suites for your C projects — even in tricky embedded systems.
-Ceedling and its complementary pieces and parts are (and always will be) freely
-available and open source. **_[Ceedling Assist][ceedling-pro]_** is a growing list
-of paid products and services to help you do even more with these tools.
-[ceedling-pro]: https://www.thingamabyte.com/ceedling
 ⭐️ **Eager to just get going? Jump to
 [📚 Documentation & Learning](#-documentation--learning) and
 [🚀 Getting Started](#-getting-started).**
+For a test suite project using the default toolchain `gcc`, Ceedling’s
+configuration file could be as simple as this:
+```yaml
+:project:
+  :build_root: project/build/
+:paths:
+  :test:
+    - tests/**
+  :source:
+    - source/**
+  :include:
+    - inc/**
+```
+To execute all your unit tests, you would run `ceedling test:all`. That‘s it!
 Ceedling works the way developers want to work. It is flexible and entirely
 command-line driven. It drives code generation and command line tools for you.
 All generated and framework code is easy to see and understand.
@@ -32,17 +74,32 @@ Ceedling’s features support all types of C development from low-level embedded
 to enterprise systems. No tool is perfect, but Ceedling can do a whole lot to
 help you and your team produce quality software.
+## Supporting this work
+Ceedling and its complementary [ThrowTheSwitch] pieces and parts are and always
+will be freely available and open source.
+💼 **_[Ceedling Suite][ceedling-suite]_** is a growing collection of paid
+products and services built around Ceedling to help you do even more.
+**_[Ceedling Assist][ceedling-assist]_** for support contracts and training
+is now available.
+🙏🏻 **[Please consider supporting Ceedling as a Github Sponsor][tts-sponsor]**
+[ThrowTheSwitch]: https://github.com/ThrowTheSwitch
+[ceedling-suite]: https://www.thingamabyte.com/ceedling
+[ceedling-assist]: https://www.thingamabyte.com/ceedlingassist
+[tts-sponsor]: https://github.com/sponsors/ThrowTheSwitch
 ## Ceedling is a suite of tools
-Ceedling is also a suite of tools. It is the glue for bringing together three
+Ceedling is also a suite of tools. It is the glue for bringing together two
 other awesome open-source projects you can’t live without if you‘re creating
 awesomeness in the C language.
 1. **[Unity]**, an [xUnit]-style test framework.
 1. **[CMock]**<sup>†</sup>, a code generating,
    [function mocking & stubbing][test-doubles] kit for interaction-based testing.
-1. **[CException]**, a framework for adding simple exception handling to C projects
-   in the style of higher-order programming languages.
 <sup>†</sup> Through a [plugin][FFF-plugin], Ceedling also supports [FFF] for
 [fake functions][test-doubles] as an alternative to CMock’s mocks and stubs.
@@ -52,13 +109,13 @@ awesomeness in the C language.
 For simple project structures, Ceedling can build and test an entire project
 from just a few lines in its project configuration file.
-Because it handles all the nitty-gritty of rebuilds and becuase of Unity and
+Because it handles all the nitty-gritty of rebuilds and because of Unity and
 CMock, Ceedling makes [Test-Driven Development][TDD] in C a breeze. It even
 provides handy backtrace debugging options for finding the source of crashing
 code exercised by your unit tests.
 Ceedling is extensible with a simple plugin mechanism. It comes with a
-number of [built-in plugins][ceedling-plugins] for code coverage, test suite
+number of [built-in plugins][ceedling-docs-plugins] for code coverage, test suite
 report generation, Continuous Integration features, IDE integration, release
 library builds & dependency management, and more.
@@ -68,9 +125,37 @@ library builds & dependency management, and more.
 [CException]: https://github.com/throwtheswitch/cexception
 [TDD]: http://en.wikipedia.org/wiki/Test-driven_development
 [test-doubles]: https://blog.pragmatists.com/test-doubles-fakes-mocks-and-stubs-1a7491dfa3da
-[FFF]: https://github.com/ElectronVector/fake_function_framework
-[FFF-plugin]: plugins/fff
-[ceedling-plugins]: docs/CeedlingPacket.md#ceedling-plugins
+[FFF]: https://github.com/meekrosoft/fff
+[FFF-plugin]: https://throwtheswitch.github.io/Ceedling/latest/plugins/fff/
+<br/>
+# 📦 Releases
+Ceedling release numbering follows [SemVer convention](https://semver.org). See the [_Getting Started_](#-getting-started) section for installation details for both official releases and prereleases.
+## Official releases
+Releases have a version number `#.#.#` (`<major>.<minor>.<patch>`). Production systems and automated tooling should rely on official releases and not prereleases.
+Official releases are available as:
+1. A prepackaged Ruby Gem available through the public [RubyGems repository](https://rubygems.org/gems/ceedling) (installable with `gem install ceedling --no-document` at the command line).
+1. Ready-to-run [Docker images](https://hub.docker.com/u/throwtheswitch).
+The latest `<major>.<minor>` version is supported with limited support for earlier minor releases.
+Bug fix patches `<major>.<minor>.<patch>` are official releases. Generally speaking, if you have adopted a `<major>.<minor>` release, you should update to bug fix releases when available.
+All official releases are retained historically.
+In rare cases of fatal flaws, severe security vulnerabilities, etc. an official release may be pulled.
+## Prereleases
+Prerelease versions include `pre` in their version numbering (`#.#.#-pre.#`). Prereleases are only available as downloadable .gem files attached to [release listings](https://github.com/throwtheswitch/ceedling/releases). These require local installation steps including some basic dependencies management.
+Prereleases are ephemeral and will be pulled as development continues or bugs are found. Prereleases should not be relied upon in production systems or automated tooling. At an official release, all prior prereleases will be pulled.
+Prereleases are not officially supported, but feedback through submitting issues is very much welcome. As much help as is practical will be offered to support those exercising prereleases.
 <br/>
@@ -79,19 +164,19 @@ library builds & dependency management, and more.
 * Found a bug or want to suggest a feature?
   **[Submit an issue][ceedling-issues]** at this repo.
 * Trying to understand features or solve a testing problem? Hit the
-  **[discussion forums][forums]**.
+  **[Discourse forums][forums]**.
 * Paid training, customizations, and support contracts are available through
-  **[Ceedling Pro][ceedling-pro]**.
+  **[Ceedling Assist][ceedling-assist]**.
 The ThrowTheSwitch community follows a **[code of conduct](docs/CODE_OF_CONDUCT.md)**.
 Please familiarize yourself with our guidelines for **[contributing](docs/CONTRIBUTING.md)** to this project, be it code, reviews, documentation, or reports.
-Yes, work has begun on certified versions of the Ceedling suite of tools to be available through **[Ceedling Pro][ceedling-pro]**. [Reach out to ThingamaByte][thingama-contact] for more.
+Yes, work has begun on **[Ceedling Certified][ceedling-certified]**, a validated version of Ceedling to meet the needs of industry software certification.
 [ceedling-issues]: https://github.com/ThrowTheSwitch/Ceedling/issues
-[forums]: https://www.throwtheswitch.org/forums
-[thingama-contact]: https://www.thingamabyte.com/contact
+[forums]: https://throwtheswitch.discourse.group
+[ceedling-certified]: https://www.thingamabyte.com/ceedlingcertified
 <br/>
@@ -331,7 +416,7 @@ Ceedling can do all the magic to build and run this test code simply by enabling
 A variety of options for [community-based support][TTS-help] exist.
-Training and support contracts are available through **_[Ceedling Pro][ceedling-pro]_**
+Training and support contracts are available through **_[Ceedling Assist][ceedling-assist]_**
 [TTS-help]: https://www.throwtheswitch.org/#help-section
@@ -342,12 +427,14 @@ The [Agile Embedded Podcast][ae-podcast] includes an [episode on Ceedling][ceedl
 ## Ceedling docs
-* **_[Ceedling Packet][ceedling-packet]_** is Ceedling’s user manual. It also references and links to the documentation of the projects, _Unity_, _CMock_, and _CException_, that it weaves together into your test and release builds.
-* **[Release Notes][release-notes]**, **[Breaking Changes][breaking-changes]**, and **[Changelog][changelog]** can be found in the **[docs/](docs/)** directory along with a variety of guides and much more.
-* The **[Plugins section](https://github.com/ThrowTheSwitch/Ceedling/blob/test/ceedling_0_32_rc/docs/CeedlingPacket.md#ceedling-plugins)** within _Ceedling Packet_ lists all of Ceedling’s built-in plugins providing overviews and links to their documentation.
+* **_[Ceedling’s documentation site][ceedling-docs-site]_** contains everything you need to know to run Ceedling. It also references and links to the documentation of the projects, _Unity_ and _CMock_, that Ceedling weaves together into your test and release builds.
+* **[Release Notes][release-notes]**, **[Breaking Changes][breaking-changes]**, **[Known Issues][known-issues]**, and **[Changelog][changelog]** can be found in the **[docs/](docs/)** directory along with a number of guides (PDFs).
+* The **[Plugins section][ceedling-docs-plugins]** of Ceedling’s documentation lists all of Ceedling’s built-in plugins providing overviews and links to their documentation.
 _Note:_ Check the [Release Notes][release-notes] for a “cheat sheet” illustrating project configuration option changes for new releases in the form of a Ceedling project YAML configuration file. This may be especially useful to those already familiar with the tool wanting to update to the latest and greatest as quickly as possible.
+[ceedling-docs-plugins]: https://throwtheswitch.github.io/Ceedling/latest/plugins/
 ## Library and courses
 [ThrowTheSwitch.org][TTS]:
@@ -358,12 +445,12 @@ _Note:_ Check the [Release Notes][release-notes] for a “cheat sheet” illustr
 ## Online tutorial
-Matt Chernosky’s **[detailed tutorial][tutorial]** demonstrates using Ceedling to build a C project with test suite. As the tutorial is a number of years old, the content is a bit out of date. That said, it provides an excellent overview of a real project. Matt is the author of [FFF] and the [FFF plugin][FFF-plugin] for Ceedling.
+Matt Chernosky’s **[detailed tutorial][tutorial]** demonstrates using Ceedling to build a C project with test suite. As the tutorial is a number of years old, the content is a bit out of date. That said, it provides an excellent overview of a real project. Matt is the author of [FFF].
-[ceedling-packet]: docs/CeedlingPacket.md
 [release-notes]: docs/ReleaseNotes.md
 [breaking-changes]: docs/BreakingChanges.md
 [changelog]: docs/Changelog.md
+[known-issues]: docs/KnownIssues.md
 [TTS]: https://throwtheswitch.org
 [library]: http://www.throwtheswitch.org/library
 [running-options]: http://www.throwtheswitch.org/build/which
@@ -374,7 +461,9 @@ Matt Chernosky’s **[detailed tutorial][tutorial]** demonstrates using Ceedling
 # 🚀 Getting Started
-👀 See the **_[Quick Start](docs/CeedlingPacket.md#quick-start)_** section in Ceedling’s user manual, _Ceedling Packet_.
+👀 See the **_[Quick Start][ceedling-docs-quick-start]_** section of Ceedling’s documentation site.
+[ceedling-docs-quick-start]: https://throwtheswitch.github.io/Ceedling/latest/getting-started/quick-start/
 ## The basics
@@ -401,8 +490,8 @@ If you are working with prerelease versions of Ceedling or some other off-the-be
 The steps are similar to the preceding with two changes:
-1. `gem install --local <ceedling .gem filepath>`
-1. Any missing dependencies must be manually installed before installation of the local Ceedling gem will succeed. A local installation attempt will complain about any missing dependencies. Simply `gem install` them by name.
+1. `gem install --local <ceedling .gem filepath> --no-document`
+1. Any missing dependencies must be manually installed before installation of the local Ceedling gem will succeed. A local installation attempt will complain about any missing dependencies. Simply run `gem install` for each of them by name from the error.
 [Ruby]: https://www.ruby-lang.org/
@@ -464,13 +553,13 @@ Once the _MadScienceLab_ container’s command line is available, to run Ceedlin
 Alternatively, you can run Ceedling through the _MadScienceLab_ Docker container directly from the command line as a command line utility. The general pattern is immediately below.
 ```shell
- > docker run -it --rm -v /my/local/project/path:/home/dev/project throwtheswitch/madsciencelab-plugins:1.0.0 <Ceedling command line>
+ > docker run --rm -v /my/local/project/path:/home/dev/project throwtheswitch/madsciencelab-plugins:1.0.0 <Ceedling command line>
 ```
 As a specific example, to run all tests in a suite, the command line would be this:
 ```shell
- > docker run -it --rm -v /my/local/project/path:/home/dev/project throwtheswitch/madsciencelab-plugins:1.0.0 ceedling test:all
+ > docker run --rm -v /my/local/project/path:/home/dev/project throwtheswitch/madsciencelab-plugins:1.0.0 ceedling test:all
 ```
 In this usage, the container starts, executes Ceedling, and then ends.
@@ -503,10 +592,10 @@ See this [commented project configuration file][example-config-file] for a much
 Or, use Ceedling’s built-in `examples` & `example` commands to extract a sample project and reference its project file.
-See the [configuration section][ceedling-packet-config] in _Ceedling Packet_ for way more details on your project configuration options than we can provide here.
+See the [configuration section][ceedling-docs-config] of Ceedling’s documentation for way more details on your project configuration options than we can provide here.
 [example-config-file]: assets/project.yml
-[ceedling-packet-config]: docs/CeedlingPacket.md#the-almighty-ceedling-project-configuration-file-in-glorious-yaml
+[ceedling-docs-config]: https://throwtheswitch.github.io/Ceedling/latest/configuration/
 ## Using Ceedling’s command line (and related)
@@ -543,13 +632,19 @@ tooling setup.
 #### Installing local documentation
 Are you just getting started with Ceedling? Maybe you’d like your
-project to be installed with some of its handy [documentation](docs/)?
+project to be installed with some of its handy documentation?
 No problem! You can do this when you create a new project…
 ```shell
  > ceedling new --docs MyAwesomeProject
 ```
+The `--docs` flag exports a version of Ceedling’s HTML-based documentation site
+to your local filesystem that is navigable with your web browser.
+`ceedling docs` exports just the documentation bundle to a destination path
+of your choosing.
 #### Attaching a Ceedling version to your project
 Ceedling can be installed as a globally available Ruby gem. Ceedling can
@@ -566,7 +661,7 @@ your project:
  > ceedling new --local YourNewProjectName
 ```
-This will install all of Unity, CMock, CException, and Ceedling itself
+This will install all of Unity, CMock, and Ceedling itself
 into a new folder `vendor/` inside your project `YourNewProjectName/`.
 It will create the same simple empty directory structure for you with
 `src/` and `test/` folders as the standard `new` command.
@@ -591,7 +686,7 @@ Running Ceedling build tasks tends to look like this…
 ### Upgrading / updating Ceedling
 You can upgrade to the latest version of Ceedling at any time, automatically
-gaining access to any accompanying updates to Unity, CMock, and CException.
+gaining access to any accompanying updates to Unity and CMock.
 To update a locally installed gem…
@@ -630,123 +725,15 @@ You can enable this by adding `--gitsupport` to your `new` call.
 # 💻 Contributing to Ceedling Development
-## Alternate installation options for Ceedling development
-### Alternate local installation for development
-After installing Ruby…
-```shell
- > git clone --recursive https://github.com/throwtheswitch/ceedling.git
- > cd ceedling
- > git submodule update --init --recursive
- > bundle install
-```
-The Ceedling repository incorporates its supporting frameworks and some
-plugins via Git submodules. A simple clone may not pull in the latest
-and greatest.
-The `bundle` tool ensures you have all needed Ruby gems installed. If
-Bundler isn’t installed on your system or you run into problems, you
-might have to install it:
-```shell
- > sudo gem install bundler
-```
-If you run into trouble running bundler and get messages like _can’t
-find gem bundler (>= 0.a) with executable bundle
-(Gem::GemNotFoundException)_, you may need to install a different
-version of Bundler. For this please reference the version in the
-Gemfile.lock.
-```shell
- > sudo gem install bundler -v <version in Gemfile.lock>
-```
-### Alternate Docker image usage for development
-As an alternative to local installation of Ceedling, nearly all development
-tasks can be accomplished with the _MadScienceLab_ Docker images.
-When running an existing image as a development container, one merely needs
-to map a volume from your local Ceedling code repository to Ceedling’s
-installation location within the container. With that accomplished,
-experimenting with project builds and running self-tests is simple.
-1. Start your target Docker container from your host system terminal:
-   ```shell
-   > docker run -it --rm throwtheswitch/<image>:<tag>
-   ```
-1. Look up and note Ceedling’s installation path (listed in `version` output) from within the container command line:
-   ```shell
-   ~/project > ceedling version
-   ```
-1. Exit the container.
-1. Restart the container from your host system with the Ceedling installation
-   volume mapping from (2) and any other command line options you need:
-   ```shell
-   > docker run -it --rm -v /my/local/ceedling/repo:<container installation path> -v /my/local/experiment/path:/home/dev/project throwtheswitch/<image>:<tag>
-   ```
-For development tasks, from the container shell you can:
-1. Run experiment projects you map into the container (e.g. at _/home/dev/project_).
-1. Run the self-test suite. Navigate to the gem installation path discovered in (2) above. From this location, follow the instructions in the section that immediately follows.
-## Running Ceedling’s self-tests
-Ceedling uses [RSpec] for its tests.
-To execute tests you may run the following from the root of your local
-Ceedling repository. This test suite build option balances test coverage
-with suite execution time.
-```shell
- > rake spec
-```
-To run individual test files (Ceedling’s Ruby-based tests, that is) and
-perform other tasks, use the available Rake tasks. From the root of your
-local Ceedling repo, list those task like this:
-```shell
- > rake -T
-```
-[RSpec]: https://rspec.info
-## Working in `bin/` vs. `lib/`
-Most of Ceedling’s functionality is contained in the application code residing
-in `lib/`. Ceedling’s command line handling, startup configuration, project
-file loading, and mixin handling are contained in a “bootloader” in `bin/`.
-The code in `bin/` is the source of the `ceedling` command line tool and
-launches the application from `lib/`.
-Depending on what you’re working on you may need to run Ceedling using
-a specialized approach.
-If you are only working in `lib/`, you can:
-1. Run Ceedling using the `ceedling` command line utility you already have
-   installed. The code in `bin/` will run from your locally installed gem or
-   from within your Docker container and launch the Ceedling application for
-   you.
-1. Modify a project file by setting a path value for `:project` ↳ `:which_ceedling`
-   that points to the local copy of Ceedling you cloned from the Git repository.
-   See _CeedlingPacket_ for details.
-If you are working in `bin/`, running `ceedling` at the command line will not
-call your modified code. Instead, you must execute the path to the executable
-`ceedling` in the `bin/` folder of the local Ceedling repository you are
-working on.
+Interested in contributing to Ceedling itself? Please review the
+**[ThrowTheSwitch coding standard][coding-standard]** and the
+**[Ceedling pull request checklist][pr-checklist]** before submitting a
+contribution.
+For development installation options, running the self-test suite, working
+with the documentation tooling, code layout, etc., see
+the **[Ceedling development workflow][ceedling-dev-workflow]** guide.
+[coding-standard]: docs/ThrowTheSwitchCodingStandard.md
+[pr-checklist]: docs/CeedlingPullRequestChecklist.md
+[ceedling-dev-workflow]: https://throwtheswitch.github.io/Ceedling/latest/development/workflow/