README.md - Issue 2462963003: Update document with supported architecture information

Side by Side Diff: README.md

Issue 2462963003: Update document with supported architecture information (Closed)

Patch Set: Created 4 years, 1 month ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

OLD	NEW
1 # PDFium	1 # PDFium

2	2

3 ## News

4

5 As of 2016-05-04, GN is used to generate build files replacing GYP. GYP

6 support will remain until it is disabled in Chromium and then will be removed

7 from PDFium.

8

9 As of 2016-04-28, the Visual Studio toolchain from depot_tools is used as the

10 default Windows toolchain for Googlers. Please set DEPOT_TOOLS_WIN_TOOLCHAIN=0

11 if you need to use the system toolchain. See

12 [Windows development subsection](#WinDev) for details.

13

14

15 ## Prerequisites	3 ## Prerequisites

16	4

17 Get the chromium depot tools via the instructions at	5 Get the chromium depot tools via the instructions at

18 http://www.chromium.org/developers/how-tos/install-depot-tools (this provides	6 http://www.chromium.org/developers/how-tos/install-depot-tools (this provides

19 the gclient utility needed below).	7 the gclient utility needed below).

20	8

21 Also install Python, Subversion, and Git and make sure they're in your path.	9 Also install Python, Subversion, and Git and make sure they're in your path.

22	10

23	11

24 ###<a name="WinDev"></a> Windows development	12 ### Windows development

25	13

26 PDFium uses a similar Windows toolchain as Chromium:	14 PDFium uses a similar Windows toolchain as Chromium:

27	15

28 #### Open source contributors	16 #### Open source contributors

29 Visual Studio 2015 Update 2 or later is highly recommended.	17 Visual Studio 2015 Update 2 or later is highly recommended.

30	18

31 Run `set DEPOT_TOOLS_WIN_TOOLCHAIN=0`, or set that variable in your global	19 Run `set DEPOT_TOOLS_WIN_TOOLCHAIN=0`, or set that variable in your global

32 environment.	20 environment.

33	21

34 Compilation is done through ninja, not Visual Studio.	22 Compilation is done through ninja, not Visual Studio.

35	23

	24 ### CPU Architectures supported

	25

	26 The default architecture for Windows, Linux, and Mac is "`x64`". On Windows,

	27 "`x86`" is also supported. GN parameter "`target_cpu = "x86"`" can be used to

	28 override the default value. If you specify Android build, the default CPU

	29 architecture will be "`arm`".

	30

36	31

37 #### Google employees	32 #### Google employees

38	33

39 Run: `download_from_google_storage --config` and follow the	34 Run: `download_from_google_storage --config` and follow the

40 authentication instructions. **Note that you must authenticate with your	35 authentication instructions. **Note that you must authenticate with your

41 @google.com credentials**. Enter "0" if asked for a project-id.	36 @google.com credentials**. Enter "0" if asked for a project-id.

42	37

43 Once you've done this, the toolchain will be installed automatically for	38 Once you've done this, the toolchain will be installed automatically for

44 you in [the step](#GenBuild) below.	39 you in [the step](#GenBuild) below.

45	40

(...skipping 21 matching lines...) Expand all Loading...
67 ##<a name="GenBuild"></a> Generate the build files	62 ##<a name="GenBuild"></a> Generate the build files

68	63

69 We use GN to generate the build files and	64 We use GN to generate the build files and

70 [Ninja](http://martine.github.io/ninja/) (also included with the depot\_tools	65 [Ninja](http://martine.github.io/ninja/) (also included with the depot\_tools

71 checkout) to execute the build files.	66 checkout) to execute the build files.

72	67

73 ```	68 ```

74 gn gen <directory>	69 gn gen <directory>

75 ```	70 ```

76	71

77 If you want to set <directory> to `out/Debug` or `out/Release` you'll need to	72 ### Selecting build configuration

78 export `GYP_PDFIUM_NO_ACTION=1` to stop `gclient sync` from executing GYP

79 and overwriting your build files.

80

81 ###<a name="BuildConfig"></a> Selecting build configuration

82	73

83 PDFium may be built either with or without JavaScript support, and with	74 PDFium may be built either with or without JavaScript support, and with

84 or without XFA forms support. Both of these features are enabled by	75 or without XFA forms support. Both of these features are enabled by

85 default. Also note that the XFA feature requires JavaScript.	76 default. Also note that the XFA feature requires JavaScript.

86	77

87 Configuration is done by executing `gn args <directory>` to configure the build.	78 Configuration is done by executing `gn args <directory>` to configure the build.

88 This will launch an editor in which you can set the following arguments.	79 This will launch an editor in which you can set the following arguments.

89	80

90 ```	81 ```

91 use_goma = true # Googlers only.	82 use_goma = true # Googlers only.

(...skipping 68 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
160 and add the "Cr-Internals-Plugins-PDF" label.	151 and add the "Cr-Internals-Plugins-PDF" label.

161	152

162 ## Contributing code	153 ## Contributing code

163	154

164 For contributing code, we will follow	155 For contributing code, we will follow

165 [Chromium's process](http://dev.chromium.org/developers/contributing-code)	156 [Chromium's process](http://dev.chromium.org/developers/contributing-code)

166 as much as possible. The main exceptions is:	157 as much as possible. The main exceptions is:

167	158

168 1. Code has to conform to the existing style and not Chromium/Google style.	159 1. Code has to conform to the existing style and not Chromium/Google style.

169	160

OLD	NEW

« no previous file with comments | « no previous file | no next file » | no next file with comments »