Commit graph

91 commits

Author SHA1 Message Date
D3vil0p3r e6b7303bd1
docs: fix broken links in README 2023-12-09 23:00:52 +01:00
Robert Helgesson aeb2232d7a
home-manager: set stable release to 23.11 2023-11-24 09:23:25 +01:00
NAHO 81ab146262
readme: major cleanup
Includes the following changes:

- Remove unused reference definition.

- Sort reference definitions.

- Internally reference "Words of warning" section.

- Consistently reference.

- Fix typo.

- Format HTML code.

- Link only to first occurence per section.

- Simplify list formatting.

- Adapt 'Installation' section to manual.

- Fix punctuation.

- Wrap text at 80 characters.

- Simplify link phrasing.

- Add missing punctuation.

PR #4363
2023-10-22 01:31:56 +02:00
Robert Hensing 0f71012724
README: Remove the pills (#4181)
This removes the Nix Pills reference, because they are not a good
introduction to the Nix ecosystem, but rather a thorough explanation
of many disparate things. Reading through them might give some light
bulb moments for an intermediate reader, but that does not mean that
they're good for a beginner.

I've also removed the mention of infinite recursion without source
location. That's an old meme for a problem that has been mostly
solved. Mentioning it here has two effects:

- Propagate the outdated meme.

- Make users insensitive to bad errors. Learned helplessness. That
  kind of thing. What we really want is for them to report bad error
  messages, so that they can be fixed. And they can be fixed; just
  report them at `NixOS/nix`.
2023-06-30 22:21:26 +02:00
Robert Helgesson 33ccc5c285
Switch stable branch to release-23.05 2023-05-31 19:11:29 +02:00
Naïm Favier f2d6291150
README: move releases section higher 2023-04-28 19:18:56 +02:00
Robert Helgesson 71fa4cdf9c
home-manager: update stable version to 22.11 2022-12-02 11:49:58 +01:00
pogobanane 824202b4c4
readme: add inofficial option search 2022-11-02 00:42:57 +01:00
Robert Helgesson ac2287df5a
docs: set 22.05 as stable version 2022-06-01 21:56:45 +02:00
Jakub Kozłowski 8f3e267051
doc: make documentation links more visible 2022-05-30 22:48:07 +02:00
Kid 51ea4217f7
docs: fix README links 2022-05-25 21:49:42 +02:00
Robert Helgesson 3604a20b67
docs: fix link to rollback instructions
Fixes #2872
2022-04-07 19:22:03 +02:00
pogobanane 38156bd4ed
doc: Add link to configuration options.html (#2851) 2022-04-01 23:19:45 +02:00
Shamrock Lee 85bbc6cc12
docs: move Nix Flakes documentation to manual
In the manual:
*   Add chapter Nix Flakes
*   Add links to sections of chapter "Using Home Manager"

In README.md:
*   Remove section "Nix Flakes"
*   Add manual reference at the buttom of section "Installation"
2022-02-10 22:15:03 +01:00
Nicolas Berbiche 7eb5106548
docs: fix README flake commands
The README is corrected to mention using `home-manager switch --flake`
with Nix Flakes.
2022-01-20 12:09:33 +01:00
Robert Helgesson 46978d2047
docs: add link to contributing chapter in readme
Fixes #2638
2022-01-16 19:01:49 +01:00
Robert Helgesson b2592ae67c
docs: fix typo 2022-01-16 18:58:26 +01:00
Robert Helgesson 1477eb1555
docs: add link to Matrix room
Fixes #2639
2022-01-16 18:48:01 +01:00
Robert Helgesson 9bcad20013
home-manager: add basic i18n support
The support for translated strings is, for now, limited to strings
generated in Bash code.
2021-12-13 21:47:28 +01:00
Nicolas Berbiche 290a188dad
docs: change stable from 21.05 to 21.11 2021-12-03 18:50:22 +01:00
Robert Helgesson c855cdde20
docs: make README refer to installation chapter
This gives a single source of truth of installation instructions and
we can also point to instructions for the NixOS and nix-darwin
modules.
2021-11-15 20:51:45 +01:00
Robert Helgesson e785e67977
docs: make text more specific about Nix 2.4 support 2021-11-15 19:58:09 +01:00
Robert Helgesson accfbdf215
docs: add license section in readme 2021-11-14 00:59:24 +01:00
Robert Helgesson 0f5d93119c
docs: move usage section to chapter in manual
Also expand the chapter in various ways.
2021-11-14 00:13:54 +01:00
Sandro 520adafcb9
docs: add example how to use flakes on non-NixOS 2021-11-13 01:18:12 +01:00
Lorenzo Manacorda 39c5c7397e
docs: improve description of extraSpecialArgs 2021-11-13 01:01:01 +01:00
Arash Outadi 13e00b70a4
docs: remove $ prompts to make it easier to copy paste 2021-10-14 00:06:10 +02:00
Kid 88f9b33384
docs: update session variables suggestion for Fish 2021-10-04 20:30:22 +02:00
Romanos Skiadas 2952168ed5
docs: update session-vars info about fish shell
The docs implied that fish was not really supported, but if fish is
managed by Home Manager, the generated config does use fenv to source
the session-vars file. Update the installation instructions and FAQ to
mention that fish does work, and mention fenv in the README.
2021-09-04 23:12:17 +02:00
Kid 04955ca970
README: fix outdated description (#2131)
* README: fix outdated description
2021-06-22 16:20:13 +02:00
Robert Helgesson 5c1415d67f
docs: mark 21.05 as stable version 2021-06-05 19:54:25 +02:00
Robert Helgesson ab64dc3249
docs: make OFTC upper case 2021-05-29 20:22:40 +02:00
Robert Helgesson 3591cd2b3b
docs: switch IRC to OFTC 2021-05-29 19:29:15 +02:00
jgart 56f5f41ed4
README: typo fix (#1912) 2021-04-08 11:11:39 -04:00
Ivan Babrou cc89be5a30
docs: remove stray ` from README.md
The typo came from #1705.
2021-01-11 00:14:01 +01:00
Robert Helgesson cb1ed0d2f3
docs: rephrase warning section slightly 2021-01-09 10:09:43 +01:00
Aleksey Kladov 32371301d3
doc: clarify what is user environment 2021-01-09 08:58:46 +01:00
Vojtěch Káně 374649a15b
docs: some extension for flakes users
PR #1655
2020-12-31 15:12:40 +01:00
David Arnold ca7fd5a643
readme: use less ambiguous user name in example
The example used `user` as the username, which may be confusing.
Instead use `jdoe`, which is more clearly a username.
2020-12-25 13:16:30 +01:00
bobfp 2b1892e646
docs: make nix-channel choice more clear 2020-12-21 00:28:14 +01:00
Roosembert Palacios 6dc8de259a
flake: expose Home Manager lib 2020-12-14 21:02:15 +01:00
Robert Helgesson 072a6ea333
docs: change stable from 20.03 to 20.09 2020-11-02 23:13:20 +01:00
Ivan Tham a98ec6ec15
readme: mention that Nix 2.4 is not supported
Improves experience before people manually find #1561.
2020-10-28 23:03:00 +01:00
Niklas Hambüchen abaebf3b34
README: Remove dangling reference to IcedTea 2020-10-25 19:44:12 +01:00
zimbatm 9cf5f764e1
tree-wide: update link to the doc 2020-10-22 22:41:56 +02:00
Vladimir Serov da6077a899
README: less complex minimal flake.nix example 2020-09-30 23:27:28 +02:00
Mattia Gheda 521a808151
README: Update README.md to point to new url (#1530)
home-manager moved to a community-based project.
2020-09-29 20:30:06 +02:00
Tony Olagbaiye bfc66df13d
readme: add a basic flake usage example 2020-09-04 14:24:38 +02:00
Robert Helgesson a94c8b072e
readme: add reference to Nix Pills 2020-06-25 00:10:08 +02:00
Matthew Bauer d99f54b51b
readme: remove firefox "enableIcedTea" option
This option was actually removed in commit
3461ceebc0.
2020-05-22 00:07:53 +02:00