diff options
| author | Stefan Boberg <[email protected]> | 2023-05-02 10:01:47 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-05-02 10:01:47 +0200 |
| commit | 075d17f8ada47e990fe94606c3d21df409223465 (patch) | |
| tree | e50549b766a2f3c354798a54ff73404217b4c9af /docs | |
| parent | fix: bundle shouldn't append content zip to zen (diff) | |
| download | zen-075d17f8ada47e990fe94606c3d21df409223465.tar.xz zen-075d17f8ada47e990fe94606c3d21df409223465.zip | |
moved source directories into `/src` (#264)
* moved source directories into `/src`
* updated bundle.lua for new `src` path
* moved some docs, icon
* removed old test trees
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/API.md | 6 | ||||
| -rw-r--r-- | docs/CODING.md | 24 | ||||
| -rw-r--r-- | docs/RESTAPI.md | 16 |
3 files changed, 46 insertions, 0 deletions
diff --git a/docs/API.md b/docs/API.md new file mode 100644 index 000000000..33ca713c8 --- /dev/null +++ b/docs/API.md @@ -0,0 +1,6 @@ +# API status + +Zen exposes a REST API which is currently intended to be used from Unreal Engine +only. It is an internal implementation detail and is subject to change especially +during the beta phase. Thus it is not recommended that you interface with this API +directly. diff --git a/docs/CODING.md b/docs/CODING.md new file mode 100644 index 000000000..c4be7906c --- /dev/null +++ b/docs/CODING.md @@ -0,0 +1,24 @@ +# Naming Conventions + +The naming conventions for Zen are intended to remain close to the Unreal Engine coding style, with some minor exceptions wrt prefixes. + +* Classes/Structs - `PascalCase` +* Functions - `PascalCase()` +* Class member variables - `m_PascalCase` +* Global variables - `g_PascalCase` +* Static variables - `s_PascalCase` +* Thread local variables - `t_PascalCase` + +Those who are familiar with the UE coding standards will note that we do not require or encourage `F` prefixes on struct or classes, and we expect class members to have a `m_` member prefix. + +# Code formatting + +To ensure consistent formatting we rely on `clang-format` to automatically format source code. This leads to consistent formatting which should lead to fewer surprises and more straightforward merging. + +Formatting is ensured by using [pre-commit](https://pre-commit.com/) + +- [Ensure you have a Python install](https://www.python.org/downloads/) and that Python has been added to the PATH environment variable +- [Install pre-commit](https://pre-commit.com/#installation) so it is available in PATH +- Run pre-commit manually on staged files `pre-commit run` +- Run pre-commit manually on all files `pre-commit run --all-files` +- Install git commit hooks `pre-commit install`, which will automatically run before every commit. diff --git a/docs/RESTAPI.md b/docs/RESTAPI.md new file mode 100644 index 000000000..6b072d188 --- /dev/null +++ b/docs/RESTAPI.md @@ -0,0 +1,16 @@ +# REST API + +## Test Service + +Intended to be used for basic connectivity testing. Allows the client to fetch +various kinds of payloads via well-known URIs + +HTTP endpoint: `/test` + +`/test/size/{size}` - verbs: (`GET`) + +## Cache Service + +HTTP endpoint: `/cache` + +`/cache/` |