diff options
| author | Pauline <git@ethanlibs.co> | 2023-08-23 01:09:10 -0400 |
|---|---|---|
| committer | Pauline <git@ethanlibs.co> | 2023-08-23 01:09:10 -0400 |
| commit | a7c97d40a34b09d3f488a60106ba82ecd0e8b61e (patch) | |
| tree | bb5ec157826d2997731c15a413ce8b669f8debf2 /README.md | |
| parent | cec45d997807679e9033538b11e9478874542f15 (diff) | |
| download | Nexus-a7c97d40a34b09d3f488a60106ba82ecd0e8b61e.tar.gz Nexus-a7c97d40a34b09d3f488a60106ba82ecd0e8b61e.tar.bz2 Nexus-a7c97d40a34b09d3f488a60106ba82ecd0e8b61e.zip | |
initial community health files
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 21 insertions, 2 deletions
@@ -1,2 +1,21 @@ -# Nexus -A monorepo that houses our tools, launcher, and website. +# **Nexus** + + + +A monorepo containing our website, launcher, and tools used by Polyfrost. + +[**polyfrost.org ยป**](https://polyfrost.org) + +## Apps + +- [**`apps/desktop`**](apps/launcher): The Polyfrost launcher. +- [**`apps/website`**](apps/website): The Polyfrost website. +- [**`apps/cli`**](apps/cli): Our launcher's CLI. + +## Packages + +- [**`core`**](core) The core of our launcher, written in Rust. +- [**`pkgs/client`**](pkgs/client) A TypeScript client library to handle dataflow via RPC between UIs and our Rust core. +- [**`pkgs/ui`**](pkgs/ui) A shared React component library for our UIs. +- [**`pkgs/interface`**](pkgs/interface) The complete user interface for our Launcher. +- [**`pkgs/config`**](pkgs/config) A TypeScript library to handle configuration files. |