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

Make md2pptx pip installable #180

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
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
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,34 @@ md2pptx moves forward on Python every so often to:

Installation is straightforward:

1. Install python-pptx
2. Clone md2pptx into a new directory
1. Clone md2pptx into a new directory
2. Install the cloned directory:

```shell
pip install ./path/to/the/md2pptx/directory
```

The md2pptx repo includes all the essentials, such as funnel.py. You don't install these with eg pip. There are some optional packages, outlined in the User Guide.

You can install python-pptx with

`pip3 install python-pptx`
```shell
pip3 install python-pptx
```

(On a Raspberry Pi you might want to use `pip3` (or `python3 -m pip`) to install for Python 3.)

You will probably need to issue the following command from the directory where you install it:
Try without parameters:

```shell
md2pptx
```

You can also install directly from GitHub:

`chmod +x md2pptx`
```shell
pip install git+https://github.com/MartinPacker/md2pptx.git#egg=md2pptx
```

### Starting To Use md2pptx

Expand Down Expand Up @@ -85,3 +99,8 @@ See `docs/user-guide.html` or `docs/user-guide.md`.
### Issues & Suggestions

This repo's Issues are regularly monitored. Use them for bug reports, suggestions, and questions.

### Contributing

Clone the repository, setup a virtual environnement and install `md2pptx`
as an editable package using ``pip install -Ue .``.
Loading