Commit graph

50 commits

Author SHA1 Message Date
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
Robert Helgesson
4f9158e533
readme: add note about session variables file
If a user does not want to manage their shell configuration through
Home Manager then they have to manually make sure that the session
variables are set.
2018-01-07 17:52:13 +01:00
Robert Helgesson
26cf42049d
readme: minor rewording 2017-11-29 23:53:49 +01:00
Robert Helgesson
06d4f39e7b
home-manager: use shellHook to install
This changes the installation command from

    nix-shell $HM_PATH -A install --run 'home-manager switch'

to

    nix-shell $HM_PATH -A install

The added shell hook will print some useful information and run
`home-manager switch`.
2017-11-29 23:48:58 +01:00
Robert Helgesson
4ccf43d753
readme: use IcedTea in example 2017-11-13 00:38:26 +01:00
BjornMelgaard
fc3e82584b
readme: expand preconditions installation step
Also fix markdown list item numbering.
2017-11-06 18:02:15 +01:00
Robert Helgesson
df84c466c1
readme: update installation instructions
Also clean up usage section slightly.
2017-10-24 01:17:54 +02:00
Robert Helgesson
01d46a1751
readme: current NixOS stable is version 17.09 2017-10-04 20:45:20 +02:00
Robert Helgesson
fb5dbe13c2
readme: minor fixes 2017-10-04 00:24:59 +02:00
Robert Helgesson
e1bceb2adb
readme: add 'console' syntax highlighting 2017-09-27 13:30:05 +02:00
Linus Heckemann
34428fc709
Add overlay and instructions for using it 2017-09-27 13:27:40 +02:00
Nikita Uvarov
82c5aa82d2
readme: add man page info 2017-09-21 13:32:16 +02:00
Robert Helgesson
07b4228988
README: add instructions for release-17.03 branch
(cherry picked from commit 46f0338092)
2017-09-08 12:38:05 +02:00
Robert Helgesson
0aa549f07b
home-manager: support .config configuration path
This commit changes the default path of the Home Manager configuration
file from `~/.nixpkgs/home.nix` to `~/.config/nixpkgs/home.nix`. The
old path is still supported and will be used if the `.config` path
does not exist.

This aligns Home Manager with the preferred configuration directory in
NixOS 17.03.

Fixes #13.
2017-06-03 00:42:37 +02:00
Robert Helgesson
a4e96843e5
More descriptive header in README 2017-05-17 23:26:16 +02:00
Robert Helgesson
dfb5bbddf5
Expand installation instructions slightly
In particular, mention that non-NixOS users may have to create the
per-user `profiles` and `gcroots` directories.

Also reformat the list a little.
2017-05-17 23:15:48 +02:00
Robert Helgesson
6e3085dc22
Add note about using graphical services to README 2017-05-06 13:01:04 +02:00
Robert Helgesson
88ec7145ba
home-environment: prevent overwriting existing files
This should reduce the risk of overwriting an existing file in the
user's home directory. A file will only be replaced if it is a link
pointing to a home-manager tree inside the Nix store.

If an existing file is detected an error is written indicating the
file's path and the activation will terminate before any mutation
occurs.

Fixes #6
2017-05-06 13:01:01 +02:00
Robert Helgesson
62a9a8fa3c
Update README for 17.03 2017-04-01 23:05:36 +02:00
Robert Helgesson
d8a9182187
Fix configuration example in README 2017-02-04 19:56:44 +01:00
Robert Helgesson
a5c8362f7b
home-manager: improve command line option handling 2017-01-16 00:16:19 +01:00
Robert Helgesson
853e28647d
Add basic README file 2017-01-15 23:42:47 +01:00