summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md76
1 files changed, 39 insertions, 37 deletions
diff --git a/README.md b/README.md
index 02b43e60f4..ac195caca0 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,39 @@
-# Prism Launcher Meta
-
-Scripts to generate jsons and jars that Prism Launcher will access.
-
-## Recommended Deployment
-
-Assuming you have a Flake-based NixOS configuration
-
-- Add Flake input:
-
- ```nix
- {
- inputs.prism-meta.url = "github:PrismLauncher/meta";
- }
- ```
-
-- Import NixOS module and configure
-
- ```nix
- {inputs, ...}: {
- imports = [inputs.prism-meta.nixosModules.default];
- services.blockgame-meta = {
- enable = true;
- settings = {
- DEPLOY_TO_GIT = "true";
- GIT_AUTHOR_NAME = "Herpington Derpson";
- GIT_AUTHOR_EMAIL = "herpderp@derpmail.com";
- GIT_COMMITTER_NAME = "Herpington Derpson";
- GIT_COMMITTER_EMAIL = "herpderp@derpmail.com";
- };
- };
- }
- ```
-
-- Rebuild and activate!
-- Trigger it `systemctl start blockgame-meta.service`
-- Monitor it `journalctl -fu blockgame-meta.service`
+# Project Tick
+
+[![CI](https://github.com/Project-Tick/Project-Tick/actions/workflows/ci-launcher.yml/badge.svg)](https://github.com/Project-Tick/Project-Tick/actions)
+[![License](https://img.shields.io/badge/license-mixed-blue)](LICENSES/)
+[![CLA assistant](https://cla-assistant.io/readme/badge/Project-Tick/Project-Tick)](https://cla-assistant.io/Project-Tick/Project-Tick)
+
+Welcome to Project Tick.
+
+This repository contains the source tree for Project Tick, a modular
+ecosystem for building, packaging, and running software across multiple
+platforms.
+
+The project is organized as a unified monorepo with clearly separated
+components. Each directory represents an independent module, library,
+tool, or application that can be built and used standalone or as part
+of the larger system.
+
+Core areas include:
+- System tools and utilities (`corebinutils`, `systeminfo`, `uvim`)
+- Libraries (`ptlibzippy`, `json4cpp`, `tomlplusplus`, `libnbtplusplus`)
+- Applications (`projt-launcher`, modpacks, tools)
+- Infrastructure and integration (`meta`, `tools`, `dockerimages`)
+
+Project Tick focuses on reproducible builds, minimal dependencies,
+and full control over the software stack.
+
+## Getting Started
+
+Each component is self-contained. Refer to the individual directories
+for build and usage instructions.
+
+## Contributing
+
+Contributions are welcome. Please follow project conventions and
+component-level documentation when submitting changes.
+
+## License
+
+See the `LICENSES/` directory for detailed licensing information.