From 9550f8243cead9c3124b4fd0c41b716660b41fd0 Mon Sep 17 00:00:00 2001 From: Valerio Ageno Date: Sat, 25 May 2024 15:03:31 +0200 Subject: [PATCH] chore: remove outdated READMEs --- REPO.md | 24 ------------------------ crates/tuono_lib/README.md | 2 +- crates/tuono_lib_macros/README.md | 3 +++ packages/README.md | 6 ------ 4 files changed, 4 insertions(+), 31 deletions(-) delete mode 100644 REPO.md create mode 100644 crates/tuono_lib_macros/README.md delete mode 100644 packages/README.md diff --git a/REPO.md b/REPO.md deleted file mode 100644 index ea8e2d81..00000000 --- a/REPO.md +++ /dev/null @@ -1,24 +0,0 @@ -# Repository structure doc - -## Monorepo tool -- [Turborepo](https://turbo.build/repo) - -## Packages -> Highly inspired by [@tanstack/router](https://tanstack.com/router/latest) - -- vite-fs-router -- router-generator -- react-router -- react-router-server -- tuono-runtime (entry point) - -### JS Public interface -- tuono-runtime (all in one js framework package) - -## Crates -- tuono (cli interface) -- tuono-axum-builder (axum project builder) -- tuono-watch (folder watch reload) - -### Rust Public interface -- tuono (cli, dev and prod environment) diff --git a/crates/tuono_lib/README.md b/crates/tuono_lib/README.md index c4eb7228..b0eca0a3 100644 --- a/crates/tuono_lib/README.md +++ b/crates/tuono_lib/README.md @@ -1,3 +1,3 @@ -# Tuonolib +# tuono_lib This project exposes the interfaces to easily handle the backend build. diff --git a/crates/tuono_lib_macros/README.md b/crates/tuono_lib_macros/README.md new file mode 100644 index 00000000..52ca9129 --- /dev/null +++ b/crates/tuono_lib_macros/README.md @@ -0,0 +1,3 @@ +# tuono_lib_macros + +Macros for tuono_lib diff --git a/packages/README.md b/packages/README.md deleted file mode 100644 index fc605f13..00000000 --- a/packages/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Tuono packages - -- `tuono-vite`: Handles the bundling (with chunk splitting) -- `tuono-routes-generator`: Handles the creation of the `routeGen.tree.ts` file -- `tuono-router`: Exposes all the Functions and Components related to the routing -- `tuono`: Collects and exposes all the public APIs. It's the only published package