chore: refine README.md, license and changelog

thuasta · Dec 25, 2024 · a7f8d28 · a7f8d28
1 parent cb79174
commit a7f8d28
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,4 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
-
-[Unreleased]: https://github.com/thuasta/thuai-8
+## Unreleased
diff --git a/LICENSE → COPYING b/LICENSE → COPYING
diff --git a/README.md b/README.md
@@ -1,2 +1,26 @@
 # thuai-8
+
 Platform for the 8th Tsinghua University Artificial Intelligence Challenge
+
+## Usage
+
+This platform consists of several components:
+
+- Unity Client (`client/unity`)
+- Web Client (`client/web`)
+- Map Editor (`map_editor`)
+- C++ SDK (`sdk/cpp`)
+- Python SDK (`sdk/python`)
+- Game Server (`server`)
+
+Checkout `README.md` in corresponding directories for usage of different components.
+
+Visit [the documentation site](https://thuai-8.thuasta.org) for details.
+
+## Contributing
+
+PRs accepted!
+
+## License
+
+GPL-3.0-only © ASTA