Skip to content

Commit

Permalink
Add contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Aki-7 committed Feb 6, 2023
1 parent 5cada23 commit 7879dea
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 33 deletions.
41 changes: 8 additions & 33 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,39 +1,10 @@
= ZEN

XR Desktop Environment
XR Desktop Environment.

== Try it out
If you want to try out Zen, you should follow https://www.zwin.dev/getting_started/system_requirements[our installation guides].

== Build & Install
This section is for contributors of Zen. Regular users shuold see the above guides.

=== Dependencies

. zwin protocols +
Please see https://github.com/zwin-project/zwin[zwin-project/zwin]
to build and install.
. zen-remote +
Please see https://github.com/zwin-project/zen-remote[zwin-project/zen-remote]
to build and install.
. Other dependencies +
For Ubuntu, other dependencies can be installed with `apt-get`.
See `.github/workflows/test.yaml` and `meson.build` for the list of the
required packages.

=== Build & Install

Currently, only clang is supported (clang-14 and 15 tested).

[source, shell]
----
$ export CC=clang
$ export CXX=clang++
$ git clone https://github.com/zwin-project/zen.git
$ cd zen
$ meson build
$ ninja -C build install
----
If you want to try out Zen, you can follow
https://www.zwin.dev/getting_started/system_requirements[our installation guides].

== Start ZEN Desktop

Expand All @@ -45,7 +16,7 @@ Select `ZEN` from your display manager.

[red]#***__caution__**# +
Switching between virtual terminals may be confusing if you are not familiar
with it. You may not be able to return to your GUI desktop except by forced
with it. You may not be able to return to your GUI desktop unless you force a
reboot.

- Switch virtual terminal
Expand Down Expand Up @@ -81,3 +52,7 @@ We cannot customize these bindings for now.
|Terminate ZEN Desktop (for development convenience)

|===

== Contribution

See link:./doc/CONTRIBUTING.adoc[CONTRIBUTING.adoc].
42 changes: 42 additions & 0 deletions doc/CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
= Welcome to Zen developer guide

Thank you for investing your time in contributing to our project!

Read our https://github.com/zwin-project/.github/blob/main/CODE_OF_CONDUCT.md[Code of Conduct]
to keep our community approachable and respectable.

== Overview

Zen consists of following components.

1. https://github.com/zwin-project/zen[zen] (this repository) +
Core compositor.

2. https://github.com/zwin-project/zen-remote[zen-remote] +
A library that implements the communication layer between
the compositor running on the PC and the remote agent running on the HMD.

3. https://github.com/zwin-project/zen-mirror[zen-mirror] +
Remote agent on Meta Quest 2 / Pro.

4. https://github.com/zwin-project/zennist[zennist] +
A default space application of Zen.

[source, mermaid]
----
graph TB
%% Components
zen(zen)
remote(zen-remote)
mirror(zen-oculus-display-system)
zennist(zennist)
%% Dependencies
zen -- uses as a shared library --> remote
zen -- uses as an executable --> zennist
mirror -- uses as a git submodule --> remote
----

== Build Zen from source

TBD

0 comments on commit 7879dea

Please sign in to comment.