Browse Source

edit README

master
zeus 6 months ago
parent
commit
a51ab85e66
  1. 116
      README.md

116
README.md

@ -16,74 +16,84 @@
![alt text](images/swarmlab-network.png "") ![alt text](images/swarmlab-network.png "")
## LabInstance xelatexthesis ## LabInstance install xelatexthesis
## Quickstart ## Clone repo
This is a quickstart guide of howto use this *LabInstance xelatex thesis* mkdir project_dir
git clone https://git.swarmlab.io:3000/swarmlab/microservice-xelatexthesis.git
### create service
> >
> Click on openGui > cd project_dir/microservice-xelatexthesis
> >
> Read info > make create
> >
- or - ### start service
https://github.com/zachscrivena/simple-thesis-dissertation
>
> cd project_dir/microservice-xelatexthesis
>
>
> make start
>
### stop service
## HowTo use it >
> cd project_dir/microservice-xelatexthesis
>
(1) Edit /home/main.tex >
> make stop
>
(2) Compile LaTeX document ### list service
> >
> Click on openGui > cd project_dir/microservice-xelatexthesis
> >
> It will compile the tex document and automatically update the PDF >
> make list
> >
(3) Downloading your finished document ### clean service
### How to use biber
> >
> To compile you should call (2), biber main, (2). > ********************* MAKE SURE YOU HAVE CREATED A BACKUP, FIRST. YOU HAVE BEEN WARNED! ****************8
>
> cd project_dir/microservice-xelatexthesis
>
> make clean
> >
### Default Configuration
- Working Directory
> /home ## HowTo use it
- Default user (A) cd project_dir/microservice-xelatexthesis
> docker (1) Edit docs/main.tex
- Default password (2) Compile LaTeX document: make pdf
> docker (3) View pdf: docs/main.pdf
- Default password4root (3.1) open main.pdf with the pdf viewer of your choice (do not close it!)
> pass
### Default xeLatex main file ### Default xeLatex main file
> >
> /home/main.tex > ./docs/main.tex
> >
### Backup xeLatex src files ### Backup xeLatex src files
> >
> See More Options > Simple copy ./docs
> >
### Reasons why you must, should, and should not use LaTeX ### Reasons why you must, should, and should not use LaTeX
@ -163,48 +173,4 @@ http://www.docs.is.ed.ac.uk/skills/documents/3722/3722-2014.pdf
### RUN INSTANCE
Swarmlab services can be run in different ways.
- You can run them **through the swarmlab hybrid environment** (http://docs.swarmlab.io/SwarmLab-HowTos/swarmlab/docs/swarmlab/docs/hybrid/start-microservices.html)
- or use them individually at will on the **command line of your system**
#### CLI
> git clone ...
>
> cd [DIRECTORY]
>
#### help
>
> make help
>
#### create service
>
> make create
>
#### start service
>
> make start
>
#### stop service
>
> make stop
>
#### list service
>
> make list
>
#### clean service
>
> make clean
>

Loading…
Cancel
Save