Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 224 lines (152 sloc) 8.298 kb
45d0570 chocolateboy s/install/build/g
chocolateboy authored
1 Build instructions
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
2 =========================
3
4 The latest release of PS3 Media Server can be downloaded from:
5
6 - http://www.ps3mediaserver.org/
7
45d0570 chocolateboy s/install/build/g
chocolateboy authored
8 This document describes how to build PS3 Media Server from the source files.
9 The following software packages are required:
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
10
11 - The Java JDK (JRE is not enough)
12 - Git
13 - Maven
14 - External libraries
15
16 Read the section "Full instructions" for a complete explanation of how to
17 install all required software and how to build PMS for each operating system.
18
19
20 Short instructions
21 ------------------
22
23 If all required software packages are installed, the following commands will
24 download the latest sources and build PMS:
25
26 git clone git://github.com/ps3mediaserver/ps3mediaserver.git
27 cd ps3mediaserver
89e32be Patrick Atoon Updated documentation to reflect the changes in
Raptor399 authored
28 mvn package
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
29
30 The result will be built in the "target" directory:
31
32 (Windows) PMS-setup.exe
33 (Linux) pms-linux-generic-x.xx.x.tar.gz
34 (Mac OSX) pms-macosx-x.xx.x.dmg
35
36
37 Full instructions
38 -----------------
39
40 First all required software has to be installed:
41
42 1. Download and install Java JDK (JRE is not enough):
43
44 * (Windows) http://www.oracle.com/technetwork/java/javase/downloads/index.html
45 - Be sure to remember the install location.
46 * (Linux) `sudo apt-get install sun-java6-jdk`
68fe99d aseques Updated the information to setup the osx installerUpdated the informatio...
aseques authored
47 * (Mac OSX) https://developer.apple.com/downloads/index.action?name=for%20Xcode%20-
48 - Look for java Developer Package
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
49
50 2. Download and install Git:
51
52 * (Windows) http://code.google.com/p/msysgit/downloads/list
53 - For the "Adjusting your PATH environment" section, select
54 "Run Git from the Windows Command Prompt".
55 - For the "Configuring the line ending conversions" section,
56 select "Checkout Windows-style, commit Unix-style line endings".
57 * (Linux) `sudo apt-get install git-core git-gui git-doc`
58 * (Mac OSX) http://git-scm.com/
68fe99d aseques Updated the information to setup the osx installerUpdated the informatio...
aseques authored
59 - If you are using brew (http://mxcl.github.com/homebrew/) you just have
60 to do 'brew install git'
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
61
62 3. Download and extract Maven:
63
64 * (Windows) http://maven.apache.org/download.html
65 * (Linux) `sudo apt-get install maven3`
68fe99d aseques Updated the information to setup the osx installerUpdated the informatio...
aseques authored
66 * (Mac OSX) (nothing to do, automatically installed with java for XCode in step 1)
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
67
68 Be sure to remember the extract location.
69
70 4. Set environment variables (create new variables or append the value if the
71 variable already exists):
72
73 * (Windows)
74 - Level: System, variable: "JAVA_HOME", value: JDK install location
75 - Level: User, variable "M2_HOME", value: Maven extract location
76 - Level: User, variable "M2", value: `%M2_HOME%\bin`
77 - Level: User, variable "Path", value `%M2%`
78 * (Linux) (nothing to do)
79 * (Mac OSX) (nothing to do)
80
81 5. Download the PMS source code by cloning the GitHub repository:
82
83 git clone git://github.com/ps3mediaserver/ps3mediaserver.git
84 cd ps3mediaserver
85
86 6. Resolve and install external libraries needed by the build process:
87
88 mvn com.savage7.maven.plugins:maven-external-dependency-plugin:resolve-external
89 mvn com.savage7.maven.plugins:maven-external-dependency-plugin:install-external
90
91 At this point all required software packages are present.
92 PMS is now ready to be built.
93
94 7. Update to the latest source (optional):
95
96 git pull
97
98 8. Compile the latest version of PMS:
99
89e32be Patrick Atoon Updated documentation to reflect the changes in
Raptor399 authored
100 mvn package
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
101
102 The resulting binaries will be built in the "target" directory:
103
104 (Windows) PMS-setup.exe
105 (Linux) pms-linux-generic-x.xx.x.tar.gz
106 (Mac OSX) pms-macosx-x.xx.x.dmg
107
108
109 Automatic builds
110 ----------------
111
112 These last two commands can easily be automated using a script:
113
114 (Windows)
115
116 rem build-pms.bat
117 start /D ps3mediaserver /wait /b git pull
89e32be Patrick Atoon Updated documentation to reflect the changes in
Raptor399 authored
118 start /D ps3mediaserver /wait /b mvn package
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
119
120
121 (Linux, Mac OSX)
122
123 #!/bin/sh
124 # build-pms.sh
125 cd ps3mediaserver
126 git pull
89e32be Patrick Atoon Updated documentation to reflect the changes in
Raptor399 authored
127 mvn package
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
128
129
130 Instructions for developers
131 ---------------------------
132
133 The previous sections described how to build the latest version of PMS from its
134 sources. For most people this will be enough to keep up to date with the latest
135 official developments. However, GitHub also makes it very simple for developers
136 to fork their own version of the official PMS sources to add their own tweaks
137 or features. GitHub facilitates submitting these features as "Pull Requests" to
138 the official PMS development team.
139
140 This section describes how to set up your own fork and how to work with it from
141 Eclipse (other IDEs should require similar configuration).
142
143 * Create a GitHub account (https://github.com/).
144
145 * Set up your machine for GitHub development (http://help.github.com/).
146
147 * Fix the Git line endings on your machine (http://help.github.com/line-endings/).
148
149 * Go to the GitHub PMS repo (https://github.com/ps3mediaserver/ps3mediaserver)
150 and press the "Fork" button on the top right of the page to create your own
151 forked repository of the official sources.
152
153 * Clone the new GitHub repo to your local machine. The clone URL can be seen
154 on the main page of your repository. It should be something like this
155 (replace YOURNAME with your actual GitHub name):
156
157 git clone git@github.com:YOURNAME/ps3mediaserver.git YOURNAME
158
159 You now have the new repository on your local machine. It is time to set up an
160 integrated development environment to work with it. The steps below explain how
161 to set up Eclipse for development with Maven and Git.
162
163 * Download and install the Eclipse IDE for Java Developers (http://www.eclipse.org/downloads/).
164
165 * Install the m2e Eclipse plugin (http://eclipse.org/m2e/)
166
167 * Install the EGit Eclipse plugin (http://eclipse.org/egit/)
168
169 * In Eclipse, select the menu "Window > Show View > Git Repositories". Then
170 select "Window > Navigation > Show View Menu", choose "Add a Repository".
171 Browse for the directory where you cloned your repository and press the
172 "Search" button. Select your forked repository and press "OK".
173 The repository should appear in the Git Repositories view.
174
175 * Press the right mouse button on the repository and select "Import Maven
176 Projects" from the menu. Select the project "/pom.xml" and press "Finish".
177
178 Note: if a project with the same name already exists, click "Advanced" and
179 set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with
180 your GitHub name). Then press "Finish".
181
182 You now see the sources in Eclipse, but the project is still missing the "Git"
183 nature. In other words, it is not tied to the local repository yet. This means
184 you cannot perform any Git actions from Eclipse yet. Add the missing connection
185 by sharing the project:
186
187 * Press the right mouse button on the newly created project and select the
188 menu "Team > Share Project...". Select "Git" and press "Next >".
189 Check the checkbox "Use or create repository in parent folder of project"
190 and make sure the project is selected. Then press "Finish".
191
192 Verify that your project is now under Git control. Press the right mouse
193 button on the project and under "Team" you now see all options to work with
194 Git.
195
196 You can build PMS from Eclipse:
197
198 * Create a new run configuration under "Run > Run Configurations...", right
199 mouse button on "Maven Build", select "New", Name: `Build PMS`, Goals:
89e32be Patrick Atoon Updated documentation to reflect the changes in
Raptor399 authored
200 `package`. Select the tab "JRE" and add the following VM arguments
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
201 `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button.
202
203 You will want to run PMS from Eclipse while developing. This is how you do it:
204
205 * Create a new run configuration under "Run > Run Configurations...", right
206 mouse button on "Maven Build", select "New", Name: `Run PMS`, Base
207 directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`.
208 Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`.
89e32be Patrick Atoon Updated documentation to reflect the changes in
Raptor399 authored
209 Finally, press the "Apply" button.
cee479a Patrick Atoon Updated INSTALL to markdown format
Raptor399 authored
210
211 You are now ready to start developing!
212
213 When you are happy with your changes, you can commit them to your local
214 repository from Eclipse using right mouse button, "Team > Commit...".
215
216 When you are satisfied with your commits and want to publish them to your
217 repository at GitHub, you can press the right mouse button on the project and
218 select "Team > Push to Upstream".
219
220 If you would like to contribute to the PMS project, you can send a "Pull
221 Request" to the development team. See the help on GitHub for more details
222 (http://help.github.com/send-pull-requests/).
223
Something went wrong with that request. Please try again.