Skip to content
Snippets Groups Projects
Commit 3173eb71 authored by Santos Gallegos's avatar Santos Gallegos
Browse files

Add instructions for installing dependencies

parent a8fe0526
Branches
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 24 additions and 21 deletions
README.md
+ 24
− 21
View file @ 3173eb71
......@@ -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
......
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