From d189ff1a868c8608417b758513acb244d1f771de Mon Sep 17 00:00:00 2001 From: GOMA Date: Sun, 13 Jul 2025 20:17:28 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=89=20add=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9fff06b --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Summary + +**Current version : 1.0.0** + +This project defines the *visual foundations* of the **design system** and establishes a strategy for structuring styles to guarantee their *reusability* in the design of graphic interfaces. + +The architecture is based on the principle of **design tokens**, enabling basic components (colors, typography, sizes, etc.) to be separated and exposed as centralized CSS variables, facilitating design consistency and maintenance. + +## Project structure + +The project is organized into three main modules: + +- [**base**](./src/base/README.md) + + Contains the fundamental elements of the graphic charter: color palettes and typographic definitions. + +- [**tokens**](./src/tokens/README.md) + + Structures and transforms basic components into thematic tokens (light/dark), organized into categories (decisions, options, etc.) for direct use in interfaces. + +- [**output**](./output/) + + Contains the Generated final [`variables.css`](./output/variables.css) file, containing all global CSS variables ready for integration into front-end projects. + + +## Important + +In order to encourage the adoption of best practices, tools and technologies used in the NTIC market, this graphic charter is inspired by the [**French government's Design System (DSFR)**](https://www.systeme-de-design.gouv.fr/). It takes up the basic components, while **streamlining** and adapting them to the specific needs of the project.