Răsfoiți Sursa

Move LICENSE and README to the root, update README
Also add a few more packages for Travis

rdb 11 ani în urmă
părinte
comite
0b9f5b43c4
4 a modificat fișierele cu 84 adăugiri și 34 ștergeri
  1. 1 1
      .travis.yml
  2. 0 0
      LICENSE
  3. 83 0
      README.md
  4. 0 33
      doc/README

+ 1 - 1
.travis.yml

@@ -3,5 +3,5 @@ compiler:
   - gcc
   - clang
 before_script:
-  - sudo apt-get install python-dev libpng-dev zlib1g-dev libssl-dev libx11-dev libgl1-mesa-dev libxrandr-dev libxxf86dga-dev libxcursor-dev bison flex libfreetype6-dev libvorbis-dev libjpeg-dev
+  - sudo apt-get install python-dev libpng-dev zlib1g-dev libssl-dev libx11-dev libgl1-mesa-dev libxrandr-dev libxxf86dga-dev libxcursor-dev bison flex libfreetype6-dev libvorbis-dev libjpeg-dev libopenal-dev libode-dev libbullet-dev nvidia-cg-toolkit
 script: python makepanda/makepanda.py --everything

+ 0 - 0
doc/LICENSE → LICENSE


+ 83 - 0
README.md

@@ -0,0 +1,83 @@
+[![Build Status](https://travis-ci.org/panda3d/panda3d.svg?branch=master)](https://travis-ci.org/panda3d/panda3d)
+
+<img src="https://avatars2.githubusercontent.com/u/590956?v=3&s=200" align="right" />
+
+Panda3D
+=======
+
+Panda3D is a game engine, a framework for 3D rendering and game development for
+Python and C++ programs.  Panda3D is open-source and free for any purpose,
+including commercial ventures, thanks to its
+[liberal license](https://www.panda3d.org/license.php).  To learn more about
+Panda3D's capabilities, visit the [gallery](https://www.panda3d.org/gallery.php)
+and the [feature list](https://www.panda3d.org/features.php).  To learn how to
+use Panda3D, check the [documentation](https://www.panda3d.org/documentation.php)
+resources. If you get stuck, ask for help from our active
+[community](https://www.panda3d.org/community.php).
+
+Panda3D is licensed under the Modified BSD License.  See the LICENSE file for
+more details.
+
+Building Panda3D
+================
+
+Windows
+-------
+
+We currently build using the Microsoft Visual C++ 2010 compiler.  You do not
+need Microsoft Visual Studio to build Panda3D, though - the relevant compilers
+are included as part of the Windows 7.1 SDK.
+
+You will also need to have the third-party dependency libraries available for
+the build scripts to use.  These are available from here:
+https://www.panda3d.org/forums/viewtopic.php?f=9&t=16346
+
+After acquiring these dependencies, you may simply build Panda3D from the
+command prompt using the following command:
+
+```bash
+makepanda\makepanda.bat --everything --installer
+```
+
+When the build succeeds, it will produce an .exe file that you can use to
+install Panda3D on your system.
+
+Linux
+-----
+
+Building Panda3D on Linux is easy.  All you need is to invoke the makepanda
+script using the version of Python that you want Panda3D to be built against.
+
+Run makepanda.py with the --help option to see which options are available.
+Usually, you will want to specify the --everything option (which builds with
+support for all features for which it detects the prerequisite dependencies)
+and the --installer option (which produces an installable .deb or .rpm file
+for you to install, depending on your distribution).
+
+The following command illustrates how to build Panda3D with some common
+options:
+```bash
+python2.7 makepanda/makepanda.py --everything --installer --no-egl --no-gles --no-gles2
+```
+
+You will probably see some warnings saying that it's unable to find several
+dependency packages.  You should determine which ones you want to include in
+your build and install the respective development packages.  You may visit
+[this manual page](https://www.panda3d.org/manual/index.php/Dependencies)
+for an overview of the various dependencies.
+
+If you are on Ubuntu, this command should cover the most frequently
+used third-party packages:
+
+```bash
+sudo apt-get install python-dev libpng-dev zlib1g-dev libssl-dev libx11-dev libgl1-mesa-dev libxrandr-dev libxxf86dga-dev libxcursor-dev bison flex libfreetype6-dev libvorbis-dev libjpeg-dev libeigen3-dev libopenal-dev libode-dev libbullet-dev nvidia-cg-toolkit
+```
+
+Once Panda3D has built, you can either install the .deb or .rpm package that
+it produced (if relevant to your platform, and you added --installer).  On
+other systems, you will need to use the installpanda script to install it onto
+your system.  Careful: it is not easy to uninstall Panda3D in this way!
+
+```bash
+python2.7 makepanda/installpanda.py --prefix=/usr/local
+```

+ 0 - 33
doc/README

@@ -1,33 +0,0 @@
-Panda3D is an open source 3D Engine originally developed, and still
-actively maintained, by the Walt Disney VR Studio.  Additional
-development and support for the open source community is provided by
-the Entertainment Technology Center of Carnegie Mellon University.
-
-At the present, we are providing two completely unrelated systems for
-building Panda.  The original build system, ppremake, is still in
-active use by the VR Studio, and is useful if you want advanced build
-control. The other build system, makepanda, is designed to build
-quickly and painlessly, and is used to generate the official releases.
-
-The ppremake system is a makefile generator, and allows you to
-configure your build environment to a high degree of customization.
-It is a fairly complex build system, and it requires some comfort with
-using the command-line make utilities.
-
-The makepanda system is a Python script that directly invokes the
-compiler to build the Panda sources.  Its emphasis is on providing a
-hands-off, simple approach to building Panda.
-
-Both systems may require you to first install a number of third-party
-tools if you would like to make them available for Panda, such as
-FreeType or OpenSSL.  You may also download a zip file that contains
-precompiled versions of these third-party libraries from the Panda
-website, which is especially useful when used in conjunction with the
-makepanda system.
-
-If you are interested in compiling Panda for yourself, you are welcome
-to use either build system.  Please refer to the documents INSTALL-PP
-or INSTALL-MK, in this directory, for build instructions for ppremake
-and makepanda, respectively.  You may also be interested in
-downloading the prebuilt Panda3D binaries from the Panda website at
-http://www.panda3d.org/ .