src/README.md

   1 <!--
   2 SPDX-FileCopyrightText: 2023 Xavier Bordoy
   3
   4 SPDX-License-Identifier: CC-BY-NC-SA-4.0
   5 -->
   6
   7 # Introduction
   8
   9 `teaching-cabinet.cc` is my personal project which has a simple aim: collect what I think it's useful to teach: activities, ideas, notes, reflections, etc. But, mainly, activities. You could see as a activity repository. As I'm Mathematics Secondary teacher, then this project has very strong bias to include mathematical stuff.
  10
  11 As a personal project, I made it on my spare time. Therefore, I will create new contents or review old ones when I could, with no pre-established pace.
  12
  13 ## Autorship
  14
  15 The collection is made by myself, [Xavier Bordoy](https://mathstodon.xyz/@somenxavier). However, the collection might include contents from diverse sources, mine or from other people. In this sense:
  16
  17 - I always try to make proper attribution: write the authors and the license of their work in explicit way.
  18 - I will only choose free or permissive licenses which could allow, at least, other teachers to use materials without requiring explicit permission (Creative Commons or Public Domain are examples of those licenses).
  19
  20 Anyway, unless otherwise noted, everything here is licensed for reuse under [CC-BY-NC-SA 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en).
  21
  22 ## Resources
  23
  24 You have the source code in [git repository](https://repo.or.cz/teaching-cabinet.git). This project has no mailing list or bug triage system. If you want to send any suggestion, comment, bug or whatever, [email me](mailto:somenxavier@posteo.net). Perhaps in more mature state of the project, I will incorporate those tools.
  25
  26 ## Contribute
  27
  28 If you want to contribute to this project, you can:
  29
  30 - spread it
  31 - review the contents
  32 - creating new contents
  33
  34 By now, donations are not allowed. Maybe later.
  35
  36 ## Tools I use
  37
  38 I use [mdbook](https://rust-lang.github.io/mdBook/index.html) with the extensions: [mdbook-indexing](https://github.com/daviddrysdale/mdbook-indexing) and [mdbook-linkcheck](https://github.com/Michael-F-Bryan/mdbook-linkcheck).
  39
  40 The project is handle in [repo.or.cz](https://repo.or.cz/teaching-cabinet.git) (previously in sourcehut).
  41
  42 Images are hosted in [mathstodon posts](https://mathstodon.xyz/@somenxavier), videos on [peertube instance tubedu](https://tubedu.org/c/candoc_videos/videos) and html output in [Moritz Poldrack](https://moritz.sh/)'s server who offered gracefully after [some troubles with sourcehut pages](https://lists.sr.ht/~sircmpwn/sr.ht-discuss/%3C20231103225131.cd9376947ec87e6ebc9f709a%40posteo.net%3E).
  43