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
Robert Helgesson
9ec9f004e1
home-manager: use nix-env to list generations
...
Using the `nix-env` command is far more robust. It also has the
benefit that if the per-user `profiles` and `gcroots` directories do
not exist then they will be created with the correct permissions.
Because of the second point this commit also removes the `mkdir` step
of the installation instructions.
PR #1239
Closes #474 , #948 , #1091
2020-05-16 19:17:13 +02:00
Robert Helgesson
42e4eef749
Update documentation for release 20.03
2020-04-23 00:29:11 +02:00
Erik Arvstedt
c7b43786ad
README: add link to main manual page
...
The main manual page is highly relevant and should be easily
discoverable from the README.
PR #1059
Fixes #1048
2020-03-07 13:32:36 +01:00
Vojtěch Káně
9ab4e70d17
readme: add notes on release policy
...
PR #1046
2020-02-24 23:09:18 +01:00
eyeinsky
e5fb259872
readme: add more prominent link to the manual
...
PR #996
2020-01-26 12:04:43 +01:00
Robert Helgesson
6b6f759e7a
doc: update version number in some places
2019-10-29 23:08:46 +01:00
Robert Helgesson
8ecc311bcc
Update stable version to 19.03
...
Also prepares for 19.09.
2019-04-22 20:04:31 +02:00
Robert Helgesson
2e1c825b90
readme: expand contact section slightly
...
In particular, mention that the channel is hosted by freenode and the
channel logs are hosted by samueldr.
2019-03-23 23:20:22 +01:00
Robert Helgesson
a974ce6257
readme: add contact section with the IRC channel
2019-03-22 19:10:43 +01:00
Robert Helgesson
235a6617c4
readme: add notice that relog may be needed
...
Also add instructions for non-NixOS users to add the user channel
directory to `NIX_PATH`.
2018-12-23 10:55:30 +01:00
Lorenzo
93b10bcf3c
readme: fix .gitconfig example
...
The example was referencing `~/.gitconfig`, which isn't being checked
anymore since 356c0bf751
2018-12-12 00:17:09 +01:00
Lorenzo Manacorda
4971e3735e
readme: clarify bash/zsh compatibility
...
Makes it clearer that the compatibility mentioned only relates to the
manual loading approach.
2018-12-12 00:15:54 +01:00
Robert Helgesson
6e67bb7ae6
doc: add installation instructions to manual
...
Also minor cleanups in README.
2018-12-06 00:57:49 +01:00
Robert Helgesson
a37b5c9c61
Change installation instructions to use nix-channel
...
This avoids the uncontrollable nature of fetching the tarball as part
of the evaluation. Instead the user can decide when to update and also
perform rollbacks, if necessary.
2018-12-04 00:59:52 +01:00
Robert Helgesson
ef29f321e0
readme: switch stable channel to 18.09
2018-12-03 01:06:12 +01:00
Robert Helgesson
5013155e58
readme: documentation is now hosted on GitLab
2018-10-18 23:42:15 +02:00
Robert Helgesson
dfaccdd03b
readme: make branch suggestion more clear
...
Fixes #270 .
2018-05-22 18:14:37 +02:00
Robert Helgesson
bbcef2fd33
readme: add link to online options documentation
2018-05-11 22:38:47 +02:00
Robert Helgesson
9141d11a7d
readme: update stable NixOS version to 18.03
2018-04-19 18:29:04 +02:00
Robert Helgesson
a154e2ea1a
readme: add basic rollback instructions
2018-01-27 10:22:54 +01:00
