Skip to content

Commit

Permalink
docs: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SamiLejeune committed Jan 24, 2025
1 parent 24b3347 commit 51525c6
Showing 1 changed file with 0 additions and 59 deletions.
59 changes: 0 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,3 @@
# About (Part to remove)

Template repository for SFEIR School, this template could be use to start a school with revealJS and SFEIR School theme

Don't forget to replace all xxx by your techno

## Files to changes

- `docs/scss/slides.scss` you could put here all your custom styles
- `docs/scripts/slides.js` you will reference all the markdown here. Don't forget to have 1 function per chapter (module).
- `docs/index.html` you should reference the correct technology in header

## To helps you

Video to help you to create your slides with revealJS

[![video of how to do a sfeir school](https://img.youtube.com/vi/v4WuJIwf4lc/0.jpg)](https://www.youtube.com/watch?v=v4WuJIwf4lc)

You could also look at documentation of school theme : https://github.com/sfeir-open-source/sfeir-school-theme

## Tasks to do

- [] Change the files (cf before)
- [] Replace all xxx by your techno
- [] Remove this part of README
- [] Complete the README with your content
- [] Check that the github pages is pointing to `/docs` directory

# Content of README

The text below is the template you could use for your readme

# SFEIR School XXX

<p align="center">
<img style="display:block" width="20%" height="20%" src="./docs/assets/images/sfeir-school-logo.png" alt="SFEIR School logo">
</p>

<br/>

[Discover the SFEIR Schools](https://www.sfeir.com/fr/le-contenus-dexperts-de-la-technologie-et-de-linnovation/formation-gratuite-avec-nos-experts/)

# Slides

You can view the slides [here](https://sfeir-open-source.github.io/sfeir-school-xxx/).
Expand All @@ -55,20 +13,3 @@ Workshops are in directory `steps` :
- two directories per workshop :
- one with a README.md with workshop steps and source file to complete
- a second directory suffixed with `-solution` which contains source file with solutions.

## Contributing

### Contributing Guidelines

Read through our [contributing guidelines][contributing] to learn about our submission process, coding rules and more.

### Want to Help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing][contributing] and then check out one of our issues labeled as <kbd>help wanted</kbd> or <kbd>good first issue</kbd>.

### Code of Conduct

Help us keep Angular open and inclusive. Please read and follow our [Code of Conduct][codeofconduct].

[contributing]: CONTRIBUTING.md
[codeofconduct]: https://github.com/sfeir-open-source/code-of-conduct/blob/master/CODE_OF_CONDUCT.md

0 comments on commit 51525c6

Please sign in to comment.