liminix

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

intro.adoc (2587B)


      1 = Introduction
      2 
      3 == What is Liminix?
      4 
      5 Liminix is a Nix-based collection of software tailored for domestic
      6 wifi router or IoT devices, of the kind that OpenWrt or DD-WRT
      7 or Gargoyle or Tomato run on. It's not NixOS on your router: we target
      8 devices that are underpowered for the full NixOS experience. It uses
      9 busybox tools, musl instead of GNU libc, and s6-rc instead of systemd.
     10 
     11 The Liminix name comes from Liminis, in Latin the genitive declension of
     12 "limen", or "of the threshold". Your router stands at the threshold of
     13 your (online) home and everything you send to/receive from the outside
     14 word goes across it.
     15 
     16 == Where to find out more
     17 
     18 === The Manual
     19 
     20 You are reading it now, and it is available from wherever you
     21 are reading it :-) but its canonical location is
     22 https://www.liminix.org/doc/
     23 
     24 === Source code
     25 
     26 Liminix source code is held in git, and hosted at
     27 https://gti.telent.net/dan/liminix, with a mirror at
     28 https://github.com/telent/liminix. You can clone from either of those
     29 repos.  For more on this, see <<_contributing>>.
     30 
     31 === IRC
     32 
     33 There is an IRC channel https://webchat.oftc.net/?nick=&channels=#liminix[#liminix] registered on the https://www.oftc.net/[OFTC] network, which
     34 is a good place to ask if you want a quick answer about how to use
     35 Liminix or are looking at a new port. Be mindful that other
     36 participants may be in different timezones than your own, so do not
     37 expect an immediate answer.
     38 
     39 === Mailing lists
     40 
     41 Three Liminix mailing lists are available: all are quite low volume.
     42 To subscribe to any of these lists, send an email to
     43 listname+subscribe@liminix.org. You can write anything you want in the
     44 subject and message body: only the destination address is important.
     45 
     46 
     47 * https://lists.liminix.org/announce/maillist.html[`announce@liminix.org`] for infrequent announcements from Liminix maintainers
     48 * https://lists.liminix.org/devel/maillist.html[`devel@liminix.org`] for development-related discussion, patches, suggestions etc
     49 * https://lists.liminix.org/users/maillist.html[`users@liminix.org`] for help requests and general discussion
     50 
     51 The mailing lists are managed with Mlmmj and archived with MHonArc.
     52 
     53 === Standards of behaviour
     54 
     55 Liminix is dedicated to providing a harassment-free experience for
     56 everyone. We do not tolerate harassment of participants in any form.
     57 
     58 The Liminix <<_code_of_conduct>> applies to all Liminix spaces, including
     59 the IRC channel, mailing lists, and any other forums, both online and
     60 off. Anyone who violates the code of conduct may be sanctioned or
     61 expelled from these spaces at the discretion of the project
     62 leadership.