From 4461592689f8ff00623e658d8994e66998d6e4f8 Mon Sep 17 00:00:00 2001 From: Piotr Polesiuk Date: Thu, 3 Apr 2025 15:54:58 +0200 Subject: [PATCH] Chapter structure in a new part about conventions. --- src/README.md | 1 + src/SUMMARY.md | 6 ++++++ src/conv/code-formatting.md | 1 + src/conv/general.md | 1 + src/conv/naming.md | 1 + 5 files changed, 10 insertions(+) create mode 100644 src/conv/code-formatting.md create mode 100644 src/conv/general.md create mode 100644 src/conv/naming.md diff --git a/src/README.md b/src/README.md index e19d2e7..3b91fb2 100644 --- a/src/README.md +++ b/src/README.md @@ -7,3 +7,4 @@ the following parts. - [Part II](ref/notation.md) serves as a reference manual as well as the informal specification of Fram. - [Part III](lib/prelude.md) documents the standard library. +- [Part IV](conv/general.md) describes programming conventions. diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 4203d39..b43b540 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -15,3 +15,9 @@ # Fram Standard Library - [`Prelude`](lib/prelude.md) + +# Fram Programming Conventions + +- [General](conv/general.md) +- [Naming](conv/naming.md) +- [Code Formatting](conv/code-formatting.md) diff --git a/src/conv/code-formatting.md b/src/conv/code-formatting.md new file mode 100644 index 0000000..f4984ea --- /dev/null +++ b/src/conv/code-formatting.md @@ -0,0 +1 @@ +# Code Formatting diff --git a/src/conv/general.md b/src/conv/general.md new file mode 100644 index 0000000..23d342b --- /dev/null +++ b/src/conv/general.md @@ -0,0 +1 @@ +# General diff --git a/src/conv/naming.md b/src/conv/naming.md new file mode 100644 index 0000000..e7077a0 --- /dev/null +++ b/src/conv/naming.md @@ -0,0 +1 @@ +# Naming