Skip to content

Commit

Permalink
Update README.md for codacy
Browse files Browse the repository at this point in the history
  • Loading branch information
R0mb0 authored May 8, 2024
1 parent d31e1b8 commit 38dd0b1
Showing 1 changed file with 21 additions and 15 deletions.
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
# Private lessons announcement template

[![made-with-latex](https://img.shields.io/badge/Made%20with-LaTeX-1f425f.svg)](https://www.latex-project.org/)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/eb6df47419d6486399d9bea3ce2fdee6)](https://app.codacy.com/gh/R0mb0/Private_lessons_announcement_template/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Compilation_Test](https://github.com/R0mb0/Private_lessons_announcement_template/actions/workflows/Compilation_Test.yml/badge.svg)](https://github.com/R0mb0/Private_lessons_announcement_template/actions/workflows/Compilation_Test.yml)

### Demo image:
- ![AnnArbor:](ReadMeImgs/AnnArbor.png)
## Demo image:
- ![AnnArbor:](ReadMeImgs/AnnArbor.png)

---
## How to create your personal private lessons announcement online for free!
1. Fork this repository by pressing the second button at the top right.
2. Rename the repository as you want and change the description then Fork it!
3. ⚠️ You have to activate "Actions" on your repo; go to "Actions", click on "I understand my workflows, go ahead and enable them" ⚠️
4. Working into "Template" folder:
1. Upload your images using GitHub into the images folder!

## How to create your personal private lessons announcement online for free!

1. Fork this repository by pressing the second button at the top right.
2. Rename the repository as you want and change the description then Fork it!
3. ⚠️ You have to activate "Actions" on your repo; go to "Actions", click on
"I understand my workflows, go ahead and enable them" ⚠️
4. Working into "Template" folder:
1. Upload your images using GitHub into the images folder!
(Use the demo image on GitHub as reference for images)
1. Access the folder from main page.
2. "Add file" -> "Upload files" -> drag and drop your images here.
3. At the end, "Commit changes".
2. Edit the template file on GitHub using comments as reference, changing texts and images as you prefer. In the end don't forghet to "commit changes".
5. Wait 2 minutes, got to "Actions" -> "Compile" -> click on the last one (look at the date on right) -> scroll down the page and click on "artifact file".
6. Done! now you have your document :) .
1. Access the folder from main page.
2. "Add file" -> "Upload files" -> drag and drop your images here.
3. At the end, "Commit changes".
2. Edit the template file on GitHub using comments as reference, changing
texts and images as you prefer. In the end don't forghet to "commit changes".
5. Wait 2 minutes, got to "Actions" -> "Compile" -> click on the last one
(look at the date on right) -> scroll down the page and click on "artifact file".
6. Done! now you have your document :) .

---

# License
## License
Shield: [![CC BY-NC-SA 4.0][cc-by-nc-sa-shield]][cc-by-nc-sa]

This work is licensed under a
Expand Down

0 comments on commit 38dd0b1

Please sign in to comment.