Unverified Commit 354fed12 authored by Martín del Río's avatar Martín del Río Committed by GitHub
Browse files

Update README.md

parent d58bc545
......@@ -6,15 +6,19 @@ Lightweight, LaTeX inspired markup document editor.
## Why Lartype?
While undoubtedly LaTeX is the best tool for the task, when you need to write simpler essays, texts or documents it's somewhat of an overkill. And it is **huge**, more than 3GB for the whole package! As that was too much for me and my tasks at hand, I decided to write Lartype. I've been using it and I hope you find an use for it too.
## What can Lartype do?
[Judge by yourself](https://lartu.net/projects/lartype/informe.pdf). That's an essay we wrote for an assignment, completely on Lartype. Lartype can generate tables, style text, embed images, align and position sections and more.
## System Requirements
A x86_64 system is required to compile Lartype projects, as a 64 bit version of ![wkhtmltopdf](https://wkhtmltopdf.org/) is used to render the PDF files. Python 2 is also required. Any modern Linux system should cover this requirements without having to do anything at all.
A 64 bit, x86 compatible system is required to compile Lartype projects, as a 64 bit version of ![wkhtmltopdf](https://wkhtmltopdf.org/) is used to render the PDF files. Python 2 is also required. Any modern Linux system should cover this requirements without having to do anything at all.
## How to install
Download, clone or pull and run `install_lartype`. Lartype will be installed to $HOME/bin and added to your path. No privileges required!
Download, clone or pull (`--depth 1` recommended!) and run `install_lartype`. Lartype will be installed to $HOME/bin and added to your path. No privileges required!
## How to run
* Run `lartype -init` to initialize a new Lartype project on the current directory. All the required folders and files will be created, along with a demo project.
* Run `lartype` to compile your project to a PDF file.
* If you update Lartype -by installing a new version-, run `lartype -update` on your project directory to update the Lartype interpreter. Until you do this, you'll still be using the previous version of Lartype.
## Commands
When you initialize a new Lartype project, three folders and a file are automatically generated for you.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment