Skip to content

Commit

Permalink
Update installation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DhruvaSambrani committed Dec 2, 2020
1 parent 9c86955 commit a58d9db
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,38 @@
# Installation

[Uninstall](#uninstallation) the previous version, if any

## Windows

Go to the [latest release](https://github.com/IISERM/PaperBuilder/releases/latest) and download `PaperBuilder-Setup.exe`. Run it. You can basically click through without much thought or changes. It will install PaperBuilder and Pandoc. It will also link you to MikTex installation.

## Linux
## Linux-Ubuntu

Go to the [latest release](https://github.com/IISERM/PaperBuilder/releases/latest) and download `PaperBuilder-Setup.sh`. Run `bash PaperBuilder-Setup.sh` to install all dependencies (pandoc, texlive, python).

## I'm too smart for installers

1. Install python3.7+, a latex compiler, and pandoc. Add all to path.
2. Go to [latest release](https://github.com/IISERM/PaperBuilder/releases/latest) and download any of the `source-files` archive.
3. Extract to a folder of your choice. Add folder to path.
3. Extract to a folder of your choice. Add folder to PATH.
4. Run as `PaperBuilder.py --help`

# Uninstallation

## Windows

Either uninstall from the Control Panel, Settings, or run `PaperBuilder uninstall`. This will NOT uninstall MikTex

## Linux-Ubuntu

Run the following:

1. `rm -rf ~/.paperbuilder`
2. `sudo apt autoremove texlive-latex-extra pandoc`
3. Edit `~/.bashrc` to remove the `pprb` alias

## Non Standard installation

1. Remove the extracted folder
2. Uninstall Python3.7, the latex compiler and pandoc
3. Also remove paths from PATH.

0 comments on commit a58d9db

Please sign in to comment.