Skip to content

Commit 5e42e51

Browse files
committed
Document how to generate translation status data (closes #62)
Also remove out of date information about scripts that no longer exist
1 parent 87d197e commit 5e42e51

File tree

1 file changed

+13
-49
lines changed

1 file changed

+13
-49
lines changed

README.md

Lines changed: 13 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -9,59 +9,23 @@ This can be run using PHP's [built-in web server][webserver]
99
for local development. For the guide pages to work, you also
1010
need a local clone of the `doc-base` repository.
1111

12+
To generate the images for translation status, the GD extension
13+
is required.
14+
15+
To generate the translation status, you'll also need the English version
16+
of the documentation and whatever languages you want to generate data
17+
about.
18+
1219
```sh
20+
# Leave empty to do all languages, must include 'en' if any listed
21+
$ PHP_LANGS=""
1322
$ git clone https://github.com/php/web-doc.git
1423
$ git clone https://github.com/php/doc-base.git
24+
$ php doc-base/languages.php --clone ${PHP_LANGS:---all}
25+
$ SQLITE_DIR="${PWD}/web-doc/sqlite"
26+
$ mkdir -p ${SQLITE_DIR}
27+
$ php doc-base/scripts/translation/genrevdb.php ${SQLITE_DIR}/status.sqlite.tmp ${PHP_LANGS:-$(php doc-base/languages.php --all --list-ssv)}
1528
$ cd web-doc
1629
$ git clone https://github.com/php/web-shared.git shared
1730
$ BASE_DOCS_PATH="${PWD}/../doc-base/docs" php -S localhost:8080 router.php
1831
```
19-
20-
The instructions below here are older and you may need to adapt them to
21-
run the tools for showing translation information.
22-
23-
---
24-
25-
## Installation
26-
Requirements:
27-
- PHP 8
28-
- GD extension (for generating charts)
29-
- SQLite3
30-
31-
1. Unpack a copy of JpGraph 4.3.4 into `/include/jpgraph/` ([here](http://jpgraph.net/download/download.php?p=1))
32-
2. Increase memory limit for PHP scripts to at least 32MB
33-
3. Fill in two configuration files
34-
- `build-ops.php.sample` (rename it to `build-ops.php`)
35-
- `@GITDIR@` - absolute path to dir where scripts will clone GIT repos to and then use them for generating data
36-
- `@SQLITEDIR@` - absolute path to `/sqlite/` directory
37-
- `build-ops.sample` (rename it to `build-ops` [no ext])
38-
- `@PHP@` - path to the PHP executable file
39-
- `@DOCWEB@` - absolute path to `/www/` directory
40-
- `@PHDDIR@` - absolute path to directory with PhD installed from Git master
41-
- `@SCRIPTSDIR@`- absolute path to `/scripts/` directory
42-
- `@SQLITEDIR@` - absolute path to `/sqlite/` directory
43-
- `@SRCDIR@` - path to the directory with PHP source code in GIT repo
44-
4. You need to run the scripts/populatedocs.sh to fetch all the required documentation for the site.
45-
5. You need to run the scripts/generation.sh to generate the database and graphs (Time of generation: 2.5009639263153 s)
46-
6. Configure the virtual host under Apache. Current suggested settings are:
47-
```
48-
<VirtualHost 127.0.0.1:80>
49-
ServerName doc.php.net
50-
ServerAdmin [email protected]
51-
52-
DocumentRoot /path/to/docweb/www
53-
54-
ErrorDocument 404 /error.php
55-
php_flag register_globals Off
56-
php_flag magic_quotes_gpc Off
57-
php_flag magic_quotes_runtime Off
58-
59-
<Directory /path/to/docweb/www>
60-
Allowoverride FileInfo Options Limit
61-
Options -Indexes
62-
</Directory>
63-
</VirtualHost>
64-
```
65-
66-
## TODO
67-
- add more cowbell

0 commit comments

Comments
 (0)