Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation : Improved docs/install.md #2734

Merged
merged 6 commits into from
Jan 29, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,26 @@ require_once 'path/to/PHPWord/src/PhpWord/Autoloader.php';

The preferred method is the Composer one.

### Configuration

In order to configure you can create phpword.ini file and load configuration by calling Settings::loadConfig

``` php
<?php

Settings::loadConfig();

```

You can also specify the config file location. (Do not use phpword.ini file in vendor folder)

``` php
<?php

Settings::loadConfig(__DIR__ . '/../../phpword.ini');

```

## Samples

After installation, you can browse and use the samples that we've provided, either by command line or using browser. If you can access your PhpWord library folder using browser, point your browser to the `samples` folder, e.g. `http://localhost/PhpWord/samples/`.