mirror of
https://github.com/TheLocehiliosan/yadm
synced 2026-03-02 03:49:29 +00:00
Refactor website (#146)
* Migrate to using "remote themes" instead of forked content * Update to most recent mmistakes * Add docker-based testing * Create Makefile for test targets * Add travis-ci integration * Update badges to use shields.io * Replace splash page image (old one's attribution disappeared from unsplash.com)
This commit is contained in:
@@ -2,6 +2,7 @@
|
||||
title: "Overview"
|
||||
permalink: /docs/overview
|
||||
---
|
||||
<a name=""></a><!-- Anchor "#" used at the ends of pagination -->
|
||||
> You've spent time tweaking your computing environment. Everything operates the
|
||||
way you want. That's fantastic! Then your hard drive fails, and the computer
|
||||
needs to be rebuilt. **yadm** can restore you configurations.
|
||||
|
||||
@@ -10,28 +10,28 @@ run the commands from any directory.
|
||||
Commands below which are special to **yadm** are denoted with
|
||||
<i class="fa fa-fw fa-asterisk" aria-hidden="true"></i>,
|
||||
and those which are passed directly through to Git are denoted with
|
||||
<i class="fa fa-fw fa-git-square" aria-hidden="true"></i>.
|
||||
<i class="fab fa-fw fa-git-square" aria-hidden="true"></i>.
|
||||
|
||||
<i class="fa fa-fw fa-asterisk" aria-hidden="true"></i> `man yadm`
|
||||
: Display **yadm**'s
|
||||
[manual](https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md).
|
||||
|
||||
<i class="fa fa-fw fa-git-square" aria-hidden="true"></i> `yadm status`
|
||||
<i class="fab fa-fw fa-git-square" aria-hidden="true"></i> `yadm status`
|
||||
: Show the repository status; added, changed, removed files. Because a `$HOME`
|
||||
directory often more than only dotfiles, by default
|
||||
**yadm** ignores untracked files when displaying status.
|
||||
|
||||
<i class="fa fa-fw fa-git-square" aria-hidden="true"></i> `yadm push`, `yadm fetch`
|
||||
<i class="fab fa-fw fa-git-square" aria-hidden="true"></i> `yadm push`, `yadm fetch`
|
||||
: Send or retrive commits to/from your remote repository .
|
||||
|
||||
<i class="fa fa-fw fa-git-square" aria-hidden="true"></i> `yadm commit --amend`
|
||||
<i class="fab fa-fw fa-git-square" aria-hidden="true"></i> `yadm commit --amend`
|
||||
: Replace the last commit with a new one. Allows you to change your commit
|
||||
message or add staged changes to the previous commit.
|
||||
|
||||
<i class="fa fa-fw fa-git-square" aria-hidden="true"></i> `yadm diff`
|
||||
<i class="fab fa-fw fa-git-square" aria-hidden="true"></i> `yadm diff`
|
||||
: View changes (uncommitted) you've made to your dotfiles.
|
||||
|
||||
<i class="fa fa-fw fa-git-square" aria-hidden="true"></i> `yadm diff --cached`
|
||||
<i class="fab fa-fw fa-git-square" aria-hidden="true"></i> `yadm diff --cached`
|
||||
: View changes staged with `yadm add`. These changes will be added with the next
|
||||
commit.
|
||||
|
||||
@@ -57,12 +57,12 @@ only list the files (without decrypting them). Read about
|
||||
: Clone the repository from `<URL>`, and automatically run bootstrap if
|
||||
successful. Read about [bootstrap](bootstrap) for more details.
|
||||
|
||||
<i class="fa fa-fw fa-git-square" aria-hidden="true"></i> `yadm remote -v`
|
||||
<i class="fab fa-fw fa-git-square" aria-hidden="true"></i> `yadm remote -v`
|
||||
: Display detailed information about all configured remote repositories.
|
||||
|
||||
<i class="fa fa-fw fa-git-square" aria-hidden="true"></i> `yadm checkout -- <file>`
|
||||
<i class="fab fa-fw fa-git-square" aria-hidden="true"></i> `yadm checkout -- <file>`
|
||||
: Abandon local changes to `<file>`, replacing it with the `HEAD` revision of
|
||||
`<file>`.
|
||||
|
||||
<i class="fa fa-fw fa-git-square" aria-hidden="true"></i> `yadm checkout -b <branch-name>`
|
||||
<i class="fab fa-fw fa-git-square" aria-hidden="true"></i> `yadm checkout -b <branch-name>`
|
||||
: Create a branch called `<branch-name>`, and check the branch out.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "Example Dotfiles"
|
||||
permalink: /docs/examples
|
||||
---
|
||||
<a name=""></a><!-- Anchor "#" used at the ends of pagination -->
|
||||
Need some inspiration? Here are some public dotfiles repositories managed by
|
||||
**yadm**. Drop me a line if you have a dotfiles repo you'd like added to this
|
||||
list.
|
||||
|
||||
Reference in New Issue
Block a user