Eilles/latex2image-web
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Joseph Rautenbach 2019-01-20 23:12:36 +02:00
parent de4c883648
commit 27e905c64e
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -10,13 +10,18 @@ Bootstrap and jQuery are used in the web interface, with AJAX calls made to the
## Dependencies ## Dependencies
### Operating system
I made use of Ubuntu 18.04. Other Linux distributions should work without problems.
### Docker ### 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) ### [latex-docker](https://github.com/blang/latex-docker)
Docker image containing the required LaTeX packages preinstalled. Docker image containing the required LaTeX packages preinstalled.
Pull the image: 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`. 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 ## Notes
* The directories `temp/` and `output/` will be generated automatically inside the `latex2image-web/` directory upon first launch. * 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. * `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/`. * Final output images are stored in `output/`, and are never deleted.
## Authors ## 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 ## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.