mirror of
https://github.com/php/web-doc.git
synced 2025-08-13 14:40:31 +00:00
README update
This commit is contained in:
14
README.md
14
README.md
@ -1,23 +1,23 @@
|
||||
# doc.php.net
|
||||
This repository contains files of doc.php.net, site created to help documentation contributors doing their job by
|
||||
providing them usefull tools, statistics etc. Site has been partly rewritten in March 2014. If you have suggestions
|
||||
providing them useful tools, statistics etc. Site has been partly rewritten in March 2014. If you have suggestions,
|
||||
please contact us on `php.doc.web` mailing list or contribute by i.e. sending pull request to this repo.
|
||||
|
||||
## Installation
|
||||
Requirments:
|
||||
Requirements:
|
||||
- PHP 5
|
||||
- GD extension (for generating charts)
|
||||
- `ext/sqlite` (hopefully dissapear soon)
|
||||
- SQLite3
|
||||
|
||||
1. Unpack a copy of JpGraph 2.x into `/include/jpgraph/`
|
||||
1. Unpack a copy of JpGraph 3.0.7 into `/include/jpgraph/` ([here](http://jpgraph.net/download/download.php?p=1))
|
||||
2. You need to run the scripts/populatedocs.sh to fetch all the required documentation for the site.
|
||||
3. Increase memory limit for PHP scripts to at least 32MB
|
||||
4. Fill in two configuration files
|
||||
- `build-ops.sample.php` (rename it to `build-ops.php`)
|
||||
- `@SVNDIR@` - absolute path to dir where scripts will clone SVN repos to and use them for generating data
|
||||
- `@SVNDIR@` - absolute path to dir where scripts will clone SVN repos to and then use them for generating data
|
||||
- `build-ops-sample` (rename it to `build-ops` [no ext])
|
||||
- `@PHP@` - path to the PHP executable file
|
||||
- `@SVNDIR@` - absolute path to dir where scripts will clone SVN repos to and use them for generating data
|
||||
- `@SVNDIR@` - absolute path to dir where scripts will clone SVN repos to and then use them for generating data
|
||||
- `@DOCDIR@` - path to the directory with documentation in SVN repo
|
||||
- `@DOCWEB@` - absolute path to directory with this website
|
||||
- `@SCRIPTSDIR@`- absolute path to `/scripts/` directory
|
||||
@ -43,6 +43,4 @@ Requirments:
|
||||
```
|
||||
|
||||
## TODO
|
||||
- replace `ext/sqlite` with PDO
|
||||
- deal with jpgraph licensing problems
|
||||
- add more cowbell
|
Reference in New Issue
Block a user