From 27e905c64e1a62a058a97e62dfe8eabe55c39c82 Mon Sep 17 00:00:00 2001 From: Joseph Rautenbach Date: Sun, 20 Jan 2019 23:12:36 +0200 Subject: [PATCH] Updated readme --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6cca375..e73595c 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,18 @@ Bootstrap and jQuery are used in the web interface, with AJAX calls made to the ## Dependencies +### Operating system + +I made use of Ubuntu 18.04. Other Linux distributions should work without problems. + ### Docker -Docker CE with [non-root user support](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user). +[Docker CE](https://docs.docker.com/install/linux/docker-ce/ubuntu/) with [non-root user support](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user). ### [latex-docker](https://github.com/blang/latex-docker) Docker image containing the required LaTeX packages preinstalled. + Pull the image: ``` @@ -60,20 +65,22 @@ node app.js The web interface will be accessible at `http://127.0.0.1:3001` by default. The port and HTTP URL can be modified inside `app.js`. -Enter a LaTeX equation, for example `\frac{a}{b}`, and press Convert. The result will be displayed below. +Enter a LaTeX equation, for example `\frac{a}{b}`, and press Convert. The result will be displayed below the button. ## Notes * The directories `temp/` and `output/` will be generated automatically inside the `latex2image-web/` directory upon first launch. -* `temp/` stores temporary `.tex`, `.dvi`, and `.svg` files during compilation. -* Final output images are stored in `output/`. +* `temp/` stores temporary `.tex`, `.dvi`, and `.svg` files during compilation, which are deleted upon completion of the conversion. +* Final output images are stored in `output/`, and are never deleted. ## Authors -* **Joseph Rautenbach** - [joeraut](https://github.com/joeraut) +* Joseph Rautenbach - [joeraut](https://github.com/joeraut) -Also, see the list of [contributors](https://github.com/ImpactInc/build-indicator/graphs/contributors) who participated in this project. +## Issues + +For any issues or bugs, please submit an issue or pull request. ## License -This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details \ No newline at end of file +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. \ No newline at end of file