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 The project `teaching-cabinet.cc` is my personal project. Its aim is to collect what I think it's useful to teach: activities, ideas, notes, reflections, etc. It's possible it has a bias to include mathematical stuff.
  10
  11 As a personal project, I made it on my spare time. Thus 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://sr.ht/~xavierb/). However, the collection might include materials from diverse sources: that is, those materials might be mine or from other people:
  16 - Always I try to make proper attribution: write explicitly the authors and the license of their work.
  17 - I will only choose free or at least permissive licenses (Creative Commons or Public Domain are example of that).
  18
  19 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).
  20
  21 ## Resources
  22
  23 - [mailing list](https://lists.sr.ht/~xavierb/teaching-cabinet-discuss) in which you can comment, make suggestions, etc.
  24 - [issue management system](https://todo.sr.ht/~xavierb/teaching-cabinet-tasks) in which you can send bugs or suggestions
  25 - [git sources](https://git.sr.ht/~xavierb/teaching-cabinet-repo)
  26
  27 ## Contribute
  28
  29 If you want to contribute to this project, you can:
  30
  31 - spread it
  32 - review the contents
  33 - creating new contents
  34
  35 By now, [donations are not allowed](https://todo.sr.ht/~xavierb/teaching-cabinet-tasks/2) until the project has more mature content.
  36
  37 ## Tools I use
  38
  39 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).
  40
  41 The project itself is hosted in [sourcehut](https://sr.ht/~xavierb/teaching-cabinet/).