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. However, the collection might include materials from diverse sources: that is, those materials might be mine or from other people. Always I try to make proper attribution: write explicitly the authors and the license of their work. I will only choose free or at least permissive licenses (Creative Commons or Public Domain for example).
  16
  17 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).
  18
  19 ## Resources
  20
  21 - [mailing list](https://lists.sr.ht/~xavierb/teaching-cabinet-discuss) in which you can comment, make suggestions, etc.
  22 - [issue management system](https://todo.sr.ht/~xavierb/teaching-cabinet-tasks) in which you can send bugs or suggestions
  23 - [git sources](https://git.sr.ht/~xavierb/teaching-cabinet-repo)
  24
  25 ## Contribute
  26
  27 If you want to contribute to this project, you can:
  28
  29 - spread it
  30 - review the contents
  31 - creating new contents
  32
  33 By now, [donations are not allowed](https://todo.sr.ht/~xavierb/teaching-cabinet-tasks/2) until the project has more mature content.
  34
  35 ## Tools I use
  36
  37 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).
  38
  39 The project itself is hosted in [sourcehut](https://sr.ht/~xavierb/teaching-cabinet/) in [amateur hacker plan](https://sourcehut.org/pricing/) ($20/year). The domain is bought in namecheap ($17 by 3 years).