From 8e0e312556db2bea931df7b18cf9207ad5c31c37 Mon Sep 17 00:00:00 2001 From: James Fraser Date: Tue, 4 Dec 2018 20:28:37 +1100 Subject: [PATCH] Added TOC to README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index ce05b5d..c01c37c 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,28 @@ [![Build Status](https://travis-ci.org/meekrosoft/fff.svg?branch=master)](https://travis-ci.org/meekrosoft/fff) [![Build status](https://ci.appveyor.com/api/projects/status/md1gn8cxnjkrkq3b/branch/master?svg=true)](https://ci.appveyor.com/project/wulfgarpro/fff/branch/master) +- [A Fake Function Framework for C](#a-fake-function-framework-for-c) +- [Hello fake world!](#hello-fake-world) +- [Capturing arguments](#capturing-arguments) +- [Return values](#return-values) +- [Resetting a fake](#resetting-a-fake) +- [Call history](#call-history) +- [Default Argument History](#default-argument-history) +- [User Defined Argument History](#user-defined-argument-history) +- [Function Return Value Sequences](#function-return-value-sequences) +- [Custom Return Value Delegate](#custom-return-value-delegate) +- [Custom Return Value Delegate Sequences](#custom-return-value-delegate-sequences) +- [Return value history](#return-value-history) +- [Variadic Functions](#variadic-functions) +- [How do I specify calling conventions for my fake functions?](#how-do-i-specify-calling-conventions-for-my-fake-functions) +- [How do I fake a function that returns a value by reference?](#how-do-i-fake-a-function-that-returns-a-value-by-reference) +- [How do I fake a function with a function pointer parameter?](#how-do-i-fake-a-function-with-a-function-pointer-parameter) +- [How do I reuse a fake across multiple test-suites?](#how-do-i-reuse-a-fake-across-multiple-test-suites) +- [Find out more...](#find-out-more) +- [Benefits](#benefits) +- [Under the hood:](#under-the-hood) +- [Cheat Sheet](#cheat-sheet) + ## A Fake Function Framework for C fff is a micro-framework for creating fake C functions for tests. Because life is too short to spend time hand-writing fake functions for testing.