Skip to content

Commit

Permalink
refactor(docs/user): shorten top-level 'README.adoc'
Browse files Browse the repository at this point in the history
Shorten the top-level 'README.adoc' file by moving the user
documentation into the 'docs/user' directory.
  • Loading branch information
trueNAHO committed Mar 11, 2024
1 parent 1e58be1 commit 2af5396
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 28 deletions.
27 changes: 0 additions & 27 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,33 +35,6 @@ Manager].

* link:docs/index.adoc[dotfiles(7)]

== Packages

|===
| Packages | Description

a|
- {home-configurations-full}[`aarch64-darwin-full`]
- {home-configurations-full}[`aarch64-linux-full`]
- {home-configurations-full}[`x86_64-darwin-full`]
- {home-configurations-full}[`x86_64-linux-full`]
a| Uses all `modules`.
|===

== Examples
:command-base: nix run nixpkgs#home-manager -- switch --flake {repository-flake-url}#

To build the <<packages, packages>> directly from {repository}[upstream] using
{home-manager}[`home-manager`], run one of the following commands:

[,bash,subs="attributes"]
----
{command-base}aarch64-darwin-full
{command-base}aarch64-linux-full
{command-base}x86_64-darwin-full
{command-base}x86_64-linux-full
----

== See Also

{repository-star-history-src-dark}[GitHub Star History], {home-manager}[Home
Expand Down
3 changes: 2 additions & 1 deletion docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ dotfiles - Documentation Overview

== See Also

link:../README.adoc[README], link:dev/index.adoc[dotfiles.dev(7)]
link:../README.adoc[README], link:dev/index.adoc[dotfiles.dev(7)],
link:user/index.adoc[dotfiles.user(1)]
9 changes: 9 additions & 0 deletions docs/user/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
= dotfiles.user(7)

== Name

dotfiles.user - User Documentation Overview

== See Also

link:../index.adoc[dotfiles(1)], link:usage.adoc[dotfiles.user.usage(7)]
41 changes: 41 additions & 0 deletions docs/user/usage.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
= dotfiles.dev.usage(7)
:toc:

== Name

dotfiles.dev.usage - TODO: add

== Description

TODO: add

== Home Manager Configurations

|===
| Packages | Description

a|
- {home-configurations-full}[`aarch64-darwin-full`]
- {home-configurations-full}[`aarch64-linux-full`]
- {home-configurations-full}[`x86_64-darwin-full`]
- {home-configurations-full}[`x86_64-linux-full`]
a| Uses all `modules`.
|===

== Examples
:command-base: nix run nixpkgs#home-manager -- switch --flake {repository-flake-url}#

To build the <<packages, packages>> directly from {repository}[upstream] using
{home-manager}[`home-manager`], run one of the following commands:

[,bash,subs="attributes"]
----
{command-base}aarch64-darwin-full
{command-base}aarch64-linux-full
{command-base}x86_64-darwin-full
{command-base}x86_64-linux-full
----

== See Also

link:index.adoc[dotfiles.user(7)]

0 comments on commit 2af5396

Please sign in to comment.