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.

Sign up for GitHub

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

pandoc is required, enhances #20 #32

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

pandoc is required, enhances #20 #32

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c33919a
pandoc is required
jeffbryner Jun 1, 2017
3b4c754
also need phantomjs
jeffbryner Jun 1, 2017
262bbe6
add phantomjs npm install
jeffbryner Jun 2, 2017
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,13 @@ package in 'developer mode' using `pip`, in a virtual environment. You also need
```sh
$ pip install -e .
```
## Prerequisites
You'll need:
- pandoc: http://pandoc.org/installing.html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, we don't really need pandoc anymore. So we can probably remove it altogether from the README + setup.py. phantomjs should be enough currently.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, it prompted when trying to install pypandoc. Is pypandoc not needed?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not at the moment. We used it at the beginning to convert privacy policies to github markdown but disabled this feature temporarily. We might do it again when we have a better cleaning process for the policies.

- phantomjs: http://phantomjs.org/download.html
npm -g install phantomjs-prebuilt

## Usage
There are two entry points, used respectively for:
1. Automagically discovering privacy policies given a list of domains
2. Fetching privacy policies given the output of the first entry point (a list of
Expand Down