From 3e3726ae43dd512afc25d6e9283a0a480f074572 Mon Sep 17 00:00:00 2001 From: Adarsh Rawat Date: Thu, 4 Apr 2024 17:00:15 +0000 Subject: [PATCH] [Docs] Add Table of Content (#4590) * [Docs] Add Table of Content * [Docs] Add a brief introduction of p4c at * Removed descriptions of P4C * Docs: Trim level of nesting in TOC to 1 * [Docs] Sync TOC in README * Refactor : Heading of TOC * Remove: Heading of p4c Introduction --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 407686d93c3..e8ea66f3655 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,31 @@ [![Validation](https://github.com/p4lang/p4c/actions/workflows/ci-validation-nightly.yml/badge.svg)](https://github.com/p4lang/p4c/actions/workflows/ci-validation-nightly.yml) [![Docker Container](https://github.com/p4lang/p4c/actions/workflows/ci-container-image.yml/badge.svg)](https://github.com/p4lang/p4c/actions/workflows/ci-container-image.yml) -# p4c + +p4c +================= + +* [Getting started](#getting-started) + * [Installing packaged versions of p4c](#installing-packaged-versions-of-p4c) + * [Installing p4c from source](#installing-p4c-from-source) +* [Dependencies](#dependencies) + * [Ubuntu dependencies](#ubuntu-dependencies) + * [Fedora dependencies](#fedora-dependencies) + * [macOS dependencies](#macos-dependencies) + * [Garbage collector](#garbage-collector) + * [Crash dumps](#crash-dumps) +* [Development tools](#development-tools) + * [Git setup](#git-setup) +* [Docker](#docker) +* [Bazel](#bazel) +* [Build system](#build-system) + * [Defining new CMake targets](#defining-new-cmake-targets) +* [Known issues](#known-issues) + * [Frontend](#frontend) + * [Backends](#backends) +* [How to Contribute](#how-to-contribute) +* [P4 Compiler Onboarding](#p4-compiler-onboarding) +* [Contact](#contact) p4c is a reference compiler for the P4 programming language. It supports both P4-14 and P4-16; you can find more information about P4