diff --git a/README.md b/README.md index 5678312f6f..790feee7b9 100644 --- a/README.md +++ b/README.md @@ -21,100 +21,28 @@ Building Interface & other High Fidelity Components Interface is our Windows, OS X, and Linux build-able client for accessing our virtual world. -For detailed notes on building for Windows, please refer to the following wiki page: -https://github.com/highfidelity/hifi/wiki/Building-on-Windows - -For detailed notes on building for Ubuntu, please refer to the following wiki page: -https://github.com/highfidelity/hifi/wiki/Building-on-Ubuntu-13.04 - -Building on Mac OS X and Linux: --------------------------------- - -CMake ------ -Hifi uses CMake to generate build files and project files -for your platform. You can download CMake at cmake.org - -Create a build directory in the root of your checkout and then run the -CMake build from there. This will keep the rest of the directory clean, -and makes the gitignore a little easier to handle (since we can just ignore -build). - - mkdir build - cd build - cmake .. -G Xcode - -Those are the commands used on OS X to run CMake from the build folder -and generate Xcode project files. - -If you are building on a *nix system, -you'll run something like "cmake ..", which uses the default Cmake generator for Unix Makefiles. - -If Cmake throws you an error related to Qt5 it likely cannot find your Qt5 cmake modules. -You can solve this by setting an environment variable, QT_CMAKE_PREFIX_PATH, to the location of the folder distributed -with Qt5 that contains them. - -For example, a Qt5 5.2.0 installation to /usr/local/qt5 would require that QT_CMAKE_PREFIX_PATH be set with the following command. This can either be entered directly into your shell session before you build or in your shell profile (e.g.: ~/.bash_profile, ~/.bashrc, ~/.zshrc - this depends on your shell and environment). - - export QT_CMAKE_PREFIX_PATH=/usr/local/qt/5.2.0/clang_64/lib/cmake/ - -The path it needs to be set to will depend on where and how Qt5 was installed. - -Building in XCode ------ - -After running cmake, you will have the make files or Xcode project file -necessary to build all of the components. For OS X, load Xcode, 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 HiFi -components located in the build/target_name/Debug directories. - -Other dependencies & information ----- -In addition to CMake, Qt 5.2 is required to build all components. - -What can I build on? -We have successfully built on OS X 10.8, Ubuntu and a few other modern Linux -distributions. A Windows build is planned for the future, but not currently in -development. - -On a fresh Ubuntu 13.10 install, get these requirements from Ubuntu repositories: - - sudo apt-get install build-essential cmake git libcurl4-openssl-dev libasound2 libxmu-dev libxi-dev freeglut3-dev libasound2-dev libjack-dev - -Then [download lastest Qt packages](http://qt-project.org/downloads), untar/install to your prefered path -and set your `QT_CMAKE_PREFIX_PATH` environment variable as described above in the CMake section. It's -recommended to set the variable automatically on each shell instance to save this task in the future: - - echo 'export QT_CMAKE_PREFIX_PATH=~/Qt5.2.0/5.2.0/gcc_64/lib/cmake' >> ~/.bashrc +All information required to build is found in the [INSTALL file](INSTALL.md]). Running Interface ------ +=== -Using Finder, locate the interface.app Application in build/interface/Debug, -double-click the icon, and wait for interface to launch. At this point you will automatically -connect to our default domain: "root.highfidelity.io". +When you launch interface, you will automatically connect to our default domain: "root.highfidelity.io". I'm in-world, what can I do? ---- If you don't see anything, make sure your preferences are pointing to root.highfidelity.io, if you still have no luck it's possible our servers are -simply down; if you're experiencing a major bug, let us know by suggesting a Job -on Worklist.net -- make sure to include details about your operating system and -your computer system. +simply down; if you're experiencing a major bug, let us know by adding an issue to this repository. +Make sure to include details about your computer and how to reproduce the bug. To move around in-world, use the arrow keys (and Shift + up/down to fly up or down) or W A S D, and E or C to fly up/down. All of the other possible options and features are available via menus in the Interface application. - Other components ======== -assignment-client, animation-server, domain-server, -pairing-server and space-server are architectural components that will allow +The assignment-client and domain-server are architectural components that will allow you to run the full stack of the virtual world should you choose to.