diff options
| -rw-r--r-- | README.md | 27 | ||||
| -rw-r--r-- | static/img/logo.jpg | 3 |
2 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..6b14995 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +<div align="center"> +<img src="static/img/logo.jpg" alt="Logo LinUS" width=250px><br> +<h1>LinUS Wiki</h1> + +Un répertoire de connaissances pour tout utilisateur linux, mais +particulièrement ceux de l'Université de sherbrooke + +</div> + +## Comment contribuer + +En premier lieu, assurez-vous d'avoir [git][1], [git-lfs][2], ainsi que [hugo][3] d'installé. +Par la suite mettez en place votre environnement de travail local selon la marche à suivre +ci-dessous: + +1. cloner le répertoire: `git clone ssh://git.chausse.xyz/linus-wiki` +2. exécuter la commande `make setup` à l'intérieur de celui-ci. Cela + auto-installe le thèmes et les outils nécessaire pour héberger une version + locale du site. +3. Démarrer un version locale du site qui se met à jour en temps réel en exécutant `make run` + +Chaque article est écrit en markdown dans le dossier `content/` du répertoire. Une fois vos +modifications terminées, soumettez les-nous par la méthode de votre choix. + +[1]: https://git-scm.com +[2]: https://git-lfs.com +[3]: https://gohugo.io diff --git a/static/img/logo.jpg b/static/img/logo.jpg new file mode 100644 index 0000000..c34c1dc --- /dev/null +++ b/static/img/logo.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eb739e61eae209a2d07b76e463a28092d34c4ba1092180d157b4168f2594424f +size 101285 |
