I prefer to start a documentation project, like the FreeBSD Handbook[1]. It could contain some in-project documentation for every module too.
[1] https://www.freebsd.org/doc/handbook/ 2016-04-09 12:48 GMT-03:00 zimbatm <[email protected]>: > Good question. The wiki seems like the right place to me but it's read-only > now. > > On Fri, 8 Apr 2016 at 11:36 Nikolay Amiantov <[email protected]> wrote: >> >> Hi, >> >> I want to add some documentation on how to use our ioquake3 derivation. >> This brings me to question on _where_ should I actually add it. Right >> now we have: >> >> 1. Nix manual: completely unrelated to my topic; >> 2. NixOS manual: primarily describes services and not packages and is >> NixOS-oriented, while my article can be of interest to Quake-playing Nix >> users in general; >> 3. nixpkgs manual: oriented at developers and packagers (as it itself >> points out). >> >> I would have added my article to the wiki, but AFAIK it's generally >> decided to get rid of it. So, where should I place articles like this? I >> would describe the general class of such documentation as "user-oriented >> nixpkgs manual". >> >> I have some other documentation articles in mind that I would like to >> write later (e.g. on steam-run), which go to the same category (I don't >> mean "games" ^_^). >> >> On 04/08/2016 12:28 PM, Nikolay Amiantov wrote: >> > I play ioquake3 successfully. It needs the following to work: >> > >> > 1. Extract pak0.pk3 file from the original Quake 3 Arena. >> > 2. Use Nix script like this: >> > >> > { nixpkgs ? import <nixpkgs> { } }: >> > >> > let >> > paks = nixpkgs.stdenv.mkDerivation { >> > name = "quake3-arena"; >> > pak0 = ./baseq3/pak0.pk3; # Replace this with path to your file >> > buildCommand = '' >> > install -D -m644 $pak0 $out/baseq3/pak0.pk3; >> > ''; >> > }; >> > in nixpkgs.quake3wrapper { >> > paks = [ paks nixpkgs.quake3pointrelease ]; >> > } >> > >> > 3. Run `nix-build` on it: `nix-build script.nix` >> > 4. `result/bin/quake3` would run the game. >> > >> > This probably needs to be added to our manual and/or improved somehow. >> >> -- >> Nikolay. >> _______________________________________________ >> nix-dev mailing list >> [email protected] >> http://lists.science.uu.nl/mailman/listinfo/nix-dev > > > _______________________________________________ > nix-dev mailing list > [email protected] > http://lists.science.uu.nl/mailman/listinfo/nix-dev > _______________________________________________ nix-dev mailing list [email protected] http://lists.science.uu.nl/mailman/listinfo/nix-dev
