Skip to content

Commit afc0b7f

Browse files
committed
(chore) readme and pptx-output dir
1 parent 2192cb1 commit afc0b7f

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,5 @@ dist/
88
workspace.code-workspace
99

1010
### Testing
11-
__tests__/pptx-output
1211
__tests__/images
1312
coverage/

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# pptx-automizer
2-
This is a pptx generator for Node.js based on templates. It can read pptx files and insert selected slides or single slide elements into another presentation. *pptx-automizer* will not write files from scratch, but edit and merge existing pptx files. Template slides are styled with PowerPoint and will be merged into the output presentation. Most of the content can be modified by using callbacks based on [xmldom](https://github.com/xmldom/xmldom).
2+
This is a pptx generator for Node.js based on templates. It can read pptx files and insert selected slides or single slide elements into another presentation. *pptx-automizer* will not write files from scratch, but edit and merge existing pptx files. Template slides are styled within PowerPoint and will be merged into the output presentation. Most of the content can be modified by using callbacks with [xmldom](https://github.com/xmldom/xmldom).
33

44
## Requirements
55
This generator can only be used on the server-side and requires a [Node.js](https://nodejs.org/en/download/package-manager/) environment.
@@ -10,6 +10,8 @@ Although, most shape types are already supported, such as connection shapes or c
1010

1111
Importing a single element is limited to shapes that also do not require further relations.
1212

13+
All testing focuses on PowerPoint 2019 pptx file format.
14+
1315
## Install
1416
You can add this package to your own project using npm or yarn:
1517
```
@@ -63,6 +65,14 @@ pres.write(`myPresentation.pptx`).then(summary => {
6365
})
6466
```
6567

68+
### Playground
69+
If you prefer instant testing, you can clone this repo and install dependencies first.
70+
Feel free and run:
71+
```
72+
yarn dev
73+
```
74+
The output file will demonstrate some of the recently implemented features.
75+
6676
### Testing
6777
You can run tests using these commands:
6878
```

__tests__/pptx-output/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)