mirror of
https://github.com/foo-dogsquared/nix-module-wrapper-manager-fds.git
synced 2025-01-31 04:58:17 +00:00
wrapper-manager-fds/docs: update default language settings
This should also fix the missing text for the theme switch button since i18n files are not matching apparently.
This commit is contained in:
parent
41f4cdcd7c
commit
07683e2147
@ -1 +1 @@
|
||||
docs/content/en-US/project-overview.adoc
|
||||
docs/content/en/project-overview.adoc
|
@ -1,5 +1,5 @@
|
||||
baseURL = 'https://foo-dogsquared.github.io/wrapper-manager-fds'
|
||||
defaultContentLanguage = 'en-US'
|
||||
defaultContentLanguage = 'en'
|
||||
title = "wrapper-manager-fds"
|
||||
timeZone = "UTC"
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
[en-US]
|
||||
[en]
|
||||
languageName = "English"
|
||||
languageCode = "en-US"
|
||||
contentDir = "content/en-US"
|
||||
languageCode = "en"
|
||||
contentDir = "content/en"
|
||||
|
@ -4,6 +4,9 @@ title: Project overview
|
||||
= nix-wrapper-manager-fds
|
||||
:toc:
|
||||
|
||||
:github-repo: foo-dogsquared/wrapper-manager-fds
|
||||
:remote-git-repo: https://github.com/foo-dogsquared/wrapper-manager-fds
|
||||
|
||||
|
||||
wrapper-manager-fds is foodogsquared's reimagining of https://github.com/viperML/wrapper-manager/[wrapper-manager].
|
||||
|
||||
@ -13,7 +16,7 @@ wrapper-manager-fds is considered unstable and the author is still freely experi
|
||||
Expect constant breakages here and put on a hard hat before exploring this part of the town.
|
||||
====
|
||||
|
||||
As a recap, the original aim of wrapper-manager is to pave a way of configuring Nix environments through wrappers.
|
||||
As a recap, the aim of wrapper-manager is to pave a way of configuring Nix environments through wrappers.
|
||||
There has been https://discourse.nixos.org/t/declarative-wrappers/1775[interest on] https://github.com/NixOS/rfcs/pull/75[this feature] footnote:[I mean, a part of the nixpkgs package set has dedicated wrappers for some packages such as GIMP, Inkscape, and Blender.] and I sometimes configure programs through wrappers instead of the typical module system.
|
||||
It has its use cases such as quickly creating variants of the same program for specific reasons (for example, creating specialized versions of yt-dlp for downloading audio, video, and more).
|
||||
But why not create something more than that?
|
||||
@ -300,12 +303,13 @@ The following configuration will create a wrapped package for yt-dlp with an add
|
||||
== Development
|
||||
|
||||
If you want to hack this hack, you'll need either Nix with flakes enabled (`experimental-features = nix-command flakes` in `nix.conf`) or not.
|
||||
Either way, this should be enough to cater both flake- and non-flake users.
|
||||
Either way, this should be enough to cater to both flake- and non-flake users.
|
||||
|
||||
This project supports the current stable and unstable version of NixOS.
|
||||
Specifically, we're looking out for the nixpkgs instance both of these versions has.
|
||||
As an implementation detail, we pin these branches through https://github.com/andir/npins[npins] which both flakes- and non-flake-based setups uses.
|
||||
Just be familiar with it and you'll be fine for the most part. footnote:[Most likely, you don't even need to interact with it for the most part since handling update cadence is handled automatically through the remote CI.]
|
||||
Just be familiar with it and you'll be fine for the most part.
|
||||
Most likely, you don't even need to interact with it since handling update cadence is handled automatically through the remote CI.
|
||||
|
||||
Setting up the development environment should be easy enough.
|
||||
|
||||
@ -319,9 +323,12 @@ Take note there is a `Makefile` full of commands intended for easily interacting
|
||||
[#development-library-set-and-modules]
|
||||
=== Library set and modules
|
||||
|
||||
This Nix project has a test infrastructure set up at link:./tests[./tests] covering the library set nad the wrapper-manager module environment.
|
||||
For its library set, it makes use of the nixpkgs library and a JSON schema to validate if it passes the whole tests.
|
||||
To make use of it, you can run it with the following commands.
|
||||
This Nix project has a test infrastructure set up at
|
||||
ifdef::env-hugo[github:{github-repo}[test directory, rev=main, path=tests]]
|
||||
ifndef::env-hugo[link:./tests[`./tests`]]
|
||||
covering the library set and the wrapper-manager module environment.
|
||||
For its library set, it makes use of the nixpkgs library and a JSON schema to validate if it passes the whole test suite.
|
||||
To make use of it, just run the following commands.
|
||||
|
||||
* For flake users, you can run `nix flake check`.
|
||||
* For non-flake users, you can do the same with `nix-build tests/ -A libTestPkg` or `nix build -f tests/ libTestPkg`.
|
||||
@ -336,7 +343,10 @@ It is also quicker to eyeball results in this way especially if you're always wo
|
||||
=== Website
|
||||
|
||||
This project also has a website set up with https://gohugo.io/[Hugo].
|
||||
The files that you need to see are in link:./docs[./docs] directory.
|
||||
The files that you need to see are in
|
||||
ifdef::env-hugo[github:foo-dogsquared/wrapper-manager-fds[`docs`, rev=main, path=docs]]
|
||||
ifndef::env-hugo[link:./docs[`./docs`]]
|
||||
directory.
|
||||
|
||||
* For flake users, you can build the website with `nix build .#website`.
|
||||
* For non-flake users, you can do the same with `nix-build docs/`.
|
||||
@ -467,8 +477,14 @@ Here's a list of resources I've found.
|
||||
== Copyright
|
||||
|
||||
This project is licensed under MIT License (SPDX identifier: https://spdx.org/licenses/MIT.html[`MIT`]).
|
||||
Just see link:./LICENSE[`./LICENSE`] for full text and details and whatnot.
|
||||
Just see
|
||||
ifdef::env-hugo[github:{github-repo}[license file, rev=main, path=LICENSE]]
|
||||
ifndef::env-hugo[link:./LICENSE[`./LICENSE`]]
|
||||
for full text and details and whatnot.
|
||||
|
||||
The documentation (except for the code examples), on the other hand, is licensed under https://www.gnu.org/licenses/fdl-1.3.txt[GNU Free Documentation License] v1.3 only with no "Invariants" section (SPDX identifier: https://spdx.org/licenses/GFDL-1.3-no-invariants-only[`GFDL-1.3-no-invariants-only`])
|
||||
You can see either the link or link:./docs/LICENSE[`./docs/LICENSE`] for more info.
|
||||
You can see either the link or
|
||||
ifdef::env-hugo[github:{github-repo}[license file, rev=main, path=docs/LICENSE]]
|
||||
ifndef::env-hugo[link:./docs/LICENSE[`./docs/LICENSE`]]
|
||||
for more info.
|
||||
The code examples, similar to the project codebase, are licensed under MIT with the same conditions apply and all that jazz.
|
Loading…
Reference in New Issue
Block a user