https://github.com/moddedtechnic/prepare-notes
A utility to convert a collection of PDF files to a Markdown file, for taking notes more easily.
https://github.com/moddedtechnic/prepare-notes
Last synced: 7 days ago
JSON representation
A utility to convert a collection of PDF files to a Markdown file, for taking notes more easily.
- Host: GitHub
- URL: https://github.com/moddedtechnic/prepare-notes
- Owner: moddedTechnic
- Created: 2022-10-27T17:56:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-27T18:44:24.000Z (over 3 years ago)
- Last Synced: 2025-01-03T12:28:08.515Z (over 1 year ago)
- Language: Shell
- Size: 1.95 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Prepare Notes
Convert a collection of PDF files containing slides into a Markdown file with a series of images, one per slide.
This can be used as a starting point for taking or consolidating notes with the given slides.
## Installation
Clone the repository somewhere sensible.
```shell
git clone https://github.com/moddedTechnic/prepare-notes.git
```
Edit the `downloads` and `editor` variables at the top of the `prepare-notes.sh` file.
`downloads` should be an absolute path to the directory where the PDFs of the slides have been downloaded to.
`editor` should be the path to the executable of the editor you wish to run.
Ensure that shell files are executable.
```shell
sudo chmod +x ./*.sh
```
Optionally, add `prepare-notes.sh` to your path.
## Usage
Simply call `prepare-notes.sh` as follows.
```shell
prepare-notes.sh target src...
```
`target` is the output directory to create the `notes.md` file in.
**WARNING**: if `target` exists and does not contain a `notes.md` file, it and any contents will be deleted.
`src` is a collection of one or more items to search for in the directory specified by `get-downloads.sh` and can contain wildcards.