README.md - Issue 29372829: Issue 4833 - Enable translations for adblockpluscore

Delta Between Two Patch Sets: README.md

Issue 29372829: Issue 4833 - Enable translations for adblockpluscore (Closed)

Left Patch Set: Created Jan. 24, 2017, 11:13 a.m.

Right Patch Set: Removed `-t generic` parameter, updated ensure_dependencies.py Created Jan. 25, 2017, 3:53 a.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Left: Side by side diff | Download
Right: Side by side diff | Download

LEFT	RIGHT
1 Adblock Plus core	1 Adblock Plus core

2 =================	2 =================

3	3

4 This repository contains the generic Adblock Plus code that's shared between	4 This repository contains the generic Adblock Plus code that's shared between

5 platforms. This repository is not designed to be used directly, but instead to	5 platforms. This repository is not designed to be used directly, but instead to

6 serve as a dependency for `adblockplus`, `adblockpluschrome` and	6 serve as a dependency for `adblockplus`, `adblockpluschrome` and

7 `libadblockplus`.	7 `libadblockplus`.

8	8

9 Translations	9 Translations

10 ------------	10 ------------

11	11

12 Translations for the strings in this project are managed using the online	12 Translations for the strings in this project are managed using the online

13 [Crowdin platform][crowdin]. To synchronise with Crowdin you can use the build	13 [Crowdin platform][crowdin]. To synchronise with Crowdin you can use the build

14 script. To get a list of the possible commands type `./build.py -t generic` at	14 script. To get a list of the possible commands type `./build.py help` at

15 the command line. (You will also need the Crowdin API key for the project.)	15 the command line. (You will also need the Crowdin API key for the project.)
Wladimir Palant 2017/01/24 11:42:45 The -t generic parameter is optional because only The -t generic parameter is optional because only one metadata file exists here. I don't think we need it in the documentation. Also, in the adblockplusui repository we called that script translate.py rather than build.py because no actual builds can be generated here - only translation-related commands are supported. Wladimir Palant 2017/01/24 11:44:08 Please ignore this point, the script is actually c Show quoted text On 2017/01/24 11:42:45, Wladimir Palant wrote: > Also, in the adblockplusui repository we called that script translate.py rather > than build.py because no actual builds can be generated here - only > translation-related commands are supported. Please ignore this point, the script is actually called build.py in adblockplusui repository as well. The optional parameter is pointless however, I'll make sure it is removed in adblockplusui repository.
16	16

17 Running the unit tests	17 Running the unit tests

18 ----------------------	18 ----------------------

19	19

20 ### Requirements	20 ### Requirements

21	21

22 In order to run the unit test suite you need	22 In order to run the unit test suite you need

23 [Node.js 6 or higher](https://nodejs.org/). Once Node.js is installed please run	23 [Node.js 6 or higher](https://nodejs.org/). Once Node.js is installed please run

24 `npm install` in the repository directory in order to install the required	24 `npm install` in the repository directory in order to install the required

25 dependencies.	25 dependencies.

26	26

27 ### Running all tests	27 ### Running all tests

28	28

29 `npm test` will run all tests in the `test` directory of the repository.	29 `npm test` will run all tests in the `test` directory of the repository.

30	30

31 ### Running specific tests	31 ### Running specific tests

32	32

33 You can specify specific test files or directories on the command line, e.g.:	33 You can specify specific test files or directories on the command line, e.g.:

34 `npm test test/synchronizer.js test/browser/elemHideEmulation.html`.	34 `npm test test/synchronizer.js test/browser/elemHideEmulation.html`.

35	35

36 ### Running the browser tests in a real browser	36 ### Running the browser tests in a real browser

37	37

38 The tests under `test/browser` require a browser environment. `npm test` will	38 The tests under `test/browser` require a browser environment. `npm test` will

39 run these in a headless browser, but you can also run them in a real one by	39 run these in a headless browser, but you can also run them in a real one by

40 opening	40 opening

41 [test/browser/elemHideEmulation.html](test/browser/elemHideEmulation.html).	41 [test/browser/elemHideEmulation.html](test/browser/elemHideEmulation.html).

LEFT	RIGHT