diff --git a/README.md b/README.md index c21d11e6bee5242e61a69f5dbcf1c6c6b8ffbb6c..1187e9350dbd7c9e53f4b892eab0b3eaeab6d92a 100644 --- a/README.md +++ b/README.md @@ -7,32 +7,35 @@ - [Pandoc](http://pandoc.org/) - [Texlive](https://www.tug.org/texlive/) (recommended) -## Quickly Usage - -Put all your paper content on `paper.md`, change the title and author -on `metadata.yaml` and run `make pdf`. The pdf will be on `build/paper.pdf`. +### Ubuntu -## Usage +```sh +sudo apt update +sudo apt install pandoc pandoc-citeproc texlive-full +``` -### Files +### Fedora -| File | Description | -|--------------------|---------------------------------------------------------------------------------| -| `metadata.yml` | On this file put all your metadata (author, title, abstract, etc) that will | -| | be use for rendering the final pdf. | -| `paper.md` | Here you put all your paper content, if you wish, you could put your content | -| | on separate files, but you must edit the `makefile`. | -| `bibliography.bib` | Here put all the bibliography that is used in the paper. | -| `bibliography.csl` | This file is for specify to pandoc how to display the cites (ieee format). | -| `template.latex` | It is used to tell pandoc how to render the paper using the metadata and | -| | content of your paper. | -| `makefile` | It is used to compile the pdf, usually the default options are fine. | -| `build/` | On this directory will be final pdf. Make sure to add this to your `.gitignore` | -| | file if you are using git. | +```sh +sudo dnf install pandoc pandoc-citeproc texlive-scheme-full +``` -### Compiling +## Quickly Usage -Run `make` on a terminal and the pdf will be on `build/paper.pdf`. +Put all your paper content on `paper.md`, change the title and author +on `metadata.yaml` and run `make`. The pdf will be on `build/paper.pdf`. + +## Files + +| File | Description | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| `metadata.yml` | On this file put all your metadata (author, title, abstract, etc) that will be use for rendering the final pdf. | +| `paper.md` | Here you put all your paper content, if you wish, you could put your content on separate files, but you must edit the `makefile`. | +| `bibliography.bib` | Here put all the bibliography that is used in the paper. | +| `bibliography.csl` | This file is for specify to pandoc how to display the cites (ieee format). | +| `template.latex` | It is used to tell pandoc how to render the paper using the metadata and content of your paper. | +| `makefile` | It is used to compile the pdf, usually the default options are fine. | +| `build/` | On this directory will be final pdf. Make sure to add this to your `.gitignore` file if you are using git. | ## Recommended Tools