From 3719cd86b6b6fd71efb21716633b6d814bcd88e5 Mon Sep 17 00:00:00 2001 From: brennenputh Date: Fri, 7 Mar 2025 14:19:22 -0700 Subject: [PATCH] Update README files in docs --- README.md | 6 ++++++ centrallix-doc/{README => README.md} | 3 +-- centrallix-sysdoc/{README => README.md} | 0 3 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 README.md rename centrallix-doc/{README => README.md} (80%) rename centrallix-sysdoc/{README => README.md} (100%) diff --git a/README.md b/README.md new file mode 100644 index 000000000..aa7821064 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# Centrallix + +This repository contains all code for the Centrallix system. + +If you are looking to use the Centrallix Widget Layer, head over to the [docs folder](./centrallix-doc/README.md). +If you are a developer aiming to contribute to Centrallix, take a look at the [sysdoc folder](./centrallix-sysdoc/README.md). diff --git a/centrallix-doc/README b/centrallix-doc/README.md similarity index 80% rename from centrallix-doc/README rename to centrallix-doc/README.md index a823d07c1..f80a342e7 100644 --- a/centrallix-doc/README +++ b/centrallix-doc/README.md @@ -1,5 +1,4 @@ - This cvs module (Centrallix-doc) is to document how to _use_ the Widget Layer -- that is, the API for making widget UIs. For documentation for developers about how Centrallix works internally, -see the centrallix-sysdoc module README file. \ No newline at end of file +see the centrallix-sysdoc module README file. diff --git a/centrallix-sysdoc/README b/centrallix-sysdoc/README.md similarity index 100% rename from centrallix-sysdoc/README rename to centrallix-sysdoc/README.md