diff --git a/docs/source/design/color.rst b/docs/source/design/color.rst new file mode 100644 index 00000000..b5d557eb --- /dev/null +++ b/docs/source/design/color.rst @@ -0,0 +1,10 @@ +##### +Color +##### + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Color Guidelines + \ No newline at end of file diff --git a/docs/source/design/color/_images/vircadia-icon-128.png b/docs/source/design/color/_images/vircadia-icon-128.png new file mode 100644 index 00000000..ea571337 Binary files /dev/null and b/docs/source/design/color/_images/vircadia-icon-128.png differ diff --git a/docs/source/design/color/_images/vircadia-logo-564.png b/docs/source/design/color/_images/vircadia-logo-564.png new file mode 100644 index 00000000..cb058473 Binary files /dev/null and b/docs/source/design/color/_images/vircadia-logo-564.png differ diff --git a/docs/source/design/color/guidelines.rst b/docs/source/design/color/guidelines.rst new file mode 100644 index 00000000..b9de743c --- /dev/null +++ b/docs/source/design/color/guidelines.rst @@ -0,0 +1,47 @@ +################ +Color Guidelines +################ + +All UI/UX should try to follow the Material Design color specification as laid out `here `_. + +----------------- +The Vircadia Logo +----------------- + +The Vircadia colors are based off its primary logo variant: + ++-------------------------------------------+------------------------------------------+ +| Icon | Logo | ++===========================================+==========================================+ +| .. image:: _images/vircadia-icon-128.png | .. image:: _images/vircadia-logo-564.png | ++-------------------------------------------+------------------------------------------+ + +------------------- +Primary Color Table +------------------- + ++------------------+----------------------+---------+------------------+----------------------+---------+ +| Dark Theme | Color | Code | Light Theme | Color | Code | ++==================+======================+=========+==================+======================+=========+ +| Primary | red.green.blue | #434343 | Primary | red.green.blue | #434343 | ++------------------+----------------------+---------+------------------+----------------------+---------+ +| Secondary | red.green.blue | #434343 | Secondary | red.green.blue | #434343 | ++------------------+----------------------+---------+------------------+----------------------+---------+ +| Tertiary | red.green.blue | #434343 | Tertiary | red.green.blue | #434343 | ++------------------+----------------------+---------+------------------+----------------------+---------+ +| Text | white | #FFFFFF | Text | Black | #000000 | ++------------------+----------------------+---------+------------------+----------------------+---------+ +| Background | vircadia-navy-blue | #182b49 | Background | vircadia-navy-blue | #182b49 | ++------------------+----------------------+---------+------------------+----------------------+---------+ + +----- +Theme +----- + +All UI/UX should have a **dark** and **light** theme for their entire layout. If the interface is in its early stages, a dark mode should take precedence because it is generally easier on the eyes for all situations. + +------------------------------ +Virtual Reality Considerations +------------------------------ + +As we get more dynamic and sleek UI experiences, it will make sense to deviate from the material design color specification's requirements in some areas. This document should be updated whenever such reviews take place. diff --git a/docs/source/designer.rst b/docs/source/designer.rst new file mode 100644 index 00000000..bfc876ec --- /dev/null +++ b/docs/source/designer.rst @@ -0,0 +1,15 @@ +######## +Designer +######## + +---------------- +Design Resources +---------------- + +Design resources such as guidelines, specifications, and tools can be found here. + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Color diff --git a/docs/source/developer.rst b/docs/source/developer.rst index 8a9fe34f..cdab5cb5 100644 --- a/docs/source/developer.rst +++ b/docs/source/developer.rst @@ -1,12 +1,12 @@ -######### -Developer -######### +#################### +Developer & Designer +#################### -Developer information such as how to build the project from source, develop, or technically manage it can be found here. +--------------------- +Development Resources +--------------------- ------------------------- -Development Instructions ------------------------- +Developer information such as how to build the project from source, develop, or technically manage it can be found here. .. toctree:: :maxdepth: 1 @@ -16,4 +16,4 @@ Development Instructions Create an Installer Interface Domain Server - Assignment Client \ No newline at end of file + Assignment Client diff --git a/docs/source/developer/build/BUILD_GENERAL.md b/docs/source/developer/build/BUILD_GENERAL.md index c8d4785d..db81ecb3 100644 --- a/docs/source/developer/build/BUILD_GENERAL.md +++ b/docs/source/developer/build/BUILD_GENERAL.md @@ -21,8 +21,8 @@ These dependencies need not be installed manually. They are automatically downloaded on the platforms where they are required. - [Bullet Physics Engine](https://github.com/bulletphysics/bullet3/releases): 2.83 - [glm](https://glm.g-truc.net/0.9.8/index.html): 0.9.8 -- [Oculus SDK](https://developer.oculus.com/downloads/): 1.11 (Win32) / 0.5 (Mac) -- [OpenVR](https://github.com/ValveSoftware/openvr): 1.11.11 (Win32 only) +- [Oculus SDK](https://developer.oculus.com/downloads/): 1.11 (Windows) / 0.5 (Mac) +- [OpenVR](https://github.com/ValveSoftware/openvr): 1.11.11 (Windows, Linux) - [Polyvox](http://www.volumesoffun.com/): 0.2.1 - [QuaZip](https://sourceforge.net/projects/quazip/files/quazip/): 0.7.3 - [SDL2](https://www.libsdl.org/download-2.0.php): 2.0.3 diff --git a/docs/source/developer/build/BUILD_OSX.md b/docs/source/developer/build/BUILD_OSX.md index b39aadb2..ccf32d71 100644 --- a/docs/source/developer/build/BUILD_OSX.md +++ b/docs/source/developer/build/BUILD_OSX.md @@ -1,6 +1,6 @@ # Build OSX -*Last Updated on April 30, 2019* +*Last Updated on July 3, 2020* Please read the [general build guide](BUILD.md) for information on dependencies required for all platforms. Only macOS specific instructions are found in this document. @@ -8,21 +8,24 @@ Please read the [general build guide](BUILD.md) for information on dependencies [Homebrew](https://brew.sh/) is an excellent package manager for macOS. It makes install of some Vircadia dependencies very simple. - brew install cmake openssl + brew install cmake openssl npm ### Python 3 Download an install Python 3.6.6 or higher from [here](https://www.python.org/downloads/). Execute the `Update Shell Profile.command` script that is provided with the installer. +### OSX SDK + +You will need the OSX SDK for building. The easiest way to get this is to install Xcode from the App Store. + ### OpenSSL Assuming you've installed OpenSSL using the homebrew instructions above, you'll need to set OPENSSL_ROOT_DIR so CMake can find your installations. -For OpenSSL installed via homebrew, set OPENSSL_ROOT_DIR: - - export OPENSSL_ROOT_DIR=/usr/local/Cellar/openssl/1.0.2l +For OpenSSL installed via homebrew, set OPENSSL_ROOT_DIR via + `export OPENSSL_ROOT_DIR=/usr/local/opt/openssl` + or by appending `-DOPENSSL_ROOT_DIR=/usr/local/opt/openssl` to `cmake` -Note that this uses the version from the homebrew formula at the time of this writing, and the version in the path will likely change. ### Xcode If Xcode is your editor of choice, you can ask CMake to generate Xcode project files instead of Unix Makefiles. @@ -34,3 +37,7 @@ If `cmake` complains about Python 3 being missing, you may need to update your C After running cmake, you will have the make files or Xcode project file necessary to build all of the components. Open the hifi.xcodeproj file, choose ALL_BUILD from the Product > Scheme menu (or target drop down), and click Run. If the build completes successfully, you will have built targets for all components located in the `build/${target_name}/Debug` directories. + +### make + +If you build with make rather than Xcode, you can append `-j4`for assigning more threads. The number indicates the number of threads, e.g. 4. diff --git a/docs/source/home.rst b/docs/source/home.rst index 8afd882b..0b03880a 100644 --- a/docs/source/home.rst +++ b/docs/source/home.rst @@ -16,7 +16,8 @@ You have the power to shape your VR experience in Vircadia. * :doc:`CREATE ` personal experiences by building avatars, domains, tablet apps, and more for you and others to enjoy. * :doc:`SCRIPT