diff --git a/README.md b/README.md index d3991af3..43fc14d9 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,15 @@ ---- -title: Home -nav_order: 1 -permalink: / ---- - -# Hello there! 👋 +# Readme ## What is it? -This website contains tips & tricks I've learned when tinkering with software or hardware. +This is the repository of the [website](https://chouffy.net/) that contains tips & tricks I've learned. -## What for? +## How does it works? -It helps me to save them in an organized fashion. -Also, maybe my notes could help one with the same problem! +- I use [Obsidian](https://obsidian.md/) to edit notes +- The [Obsidian Git plugin](https://github.com/denolehov/obsidian-git) sync that with this repository +- The website is generated with [Materials for MkDocs](https://squidfunk.github.io/mkdocs-material/) on push ## Hey, let me help you! -Well that's nice of you, [feel free to fork and commit](https://github.com/Chouffy/chouffy.github.io) 😊 -And remember, sharing is caring! +Feel free to submit a Pull Request!