Skip to content

Commit

Permalink
Merge pull request #80 from fga-eps-mds/redup
Browse files Browse the repository at this point in the history
docs: correcting some words on main page
  • Loading branch information
BrunoRiibeiro authored Dec 15, 2022
2 parents 9056623 + a672dec commit 7d4cd58
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,16 +148,16 @@ <h2>
</h2>
<div class="service_text">
<p>
In todays version of 'ez-docs', the user needs a markdown template,
In today's version of 'ez-docs', the user needs a markdown template,
a database (.csv, .txt or .xls), the pattern of the variables and
choose a flag, which will correspond to the type of file the package will create.
The value 1 of the flag creates pdf files, while 2 willl create markdown files.
The value 1 of the flag creates pdf files, while 2 will create markdown files.
Opening your terminal, the user should type something similar to:
</p>
<p class="code_text ct2">
ez-docs &ltpath to .md template&gt
&ltpath to database&gt
&ltpattern of variables&gt --flag = 1 or 2
&ltpattern of variables&gt --flag=1 or 2
</p>
</div>
</div>
Expand All @@ -179,11 +179,11 @@ <h2>
</h2>
<div class="service_text">
<p>
This quick example should make the use of the pip more clear:
This quick example should make the use of the package more clear:
</p>
<p>
The first step tu use the package is to have a markdown template
with the correct format, that will receive the data from the .csv or .xls. Your template should look something
The first step to use is to have a markdown template,
that will receive the data from the database file (.csv, .txt, .xls). Your template should look something
like this:
</p>
<p class="code_text" id="ct_var">
Expand All @@ -199,8 +199,8 @@ <h2>
<img src="images/database.png" alt="" class="img_database">
<p>
The final part is to go to your terminal and follow the "How To Use" step. Remember
to write the path to your template and database correctly and to write your markdown
keys separated with underline (_).
to write the path to your template and database correctly and to write your file name pattern
with the corrects separators.
</p>
<img src="images/exampleofuse.gif" alt="" class="img_database">
<p>
Expand Down

0 comments on commit 7d4cd58

Please sign in to comment.