aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2018-02-05 10:43:19 -0200
committerSilvio Rhatto <rhatto@riseup.net>2018-02-05 10:43:19 -0200
commit0f49a67df1cb7d4fdb9d59d0d10fdc089807d9e2 (patch)
treee184592a8d054888a3a1f5eef16ff3dff84248b7
parent7d86eee12b557ad18cbe6a24b796542c0c11fe57 (diff)
downloadinception-0f49a67df1cb7d4fdb9d59d0d10fdc089807d9e2.tar.gz
inception-0f49a67df1cb7d4fdb9d59d0d10fdc089807d9e2.tar.bz2
Updates README
-rw-r--r--README.md64
1 files changed, 61 insertions, 3 deletions
diff --git a/README.md b/README.md
index caaac6c..7ce1036 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,62 @@
-The Inception
-=============
+The Inception - locally-installed software distribution
+=======================================================
-Infects your homedir with configurations and applications.
+Infects your homedir with configuration and applications.
+
+It manages [metadot](https://git.fluxo.info/metadot) configurations
+and helps keeping your application repository synced across machines.
+
+See [rhatto's LSD](https://git.fluxo.info/rhatto/apps) for an integration
+example.
+
+Adding inception into your application tree
+-------------------------------------------
+
+Simply include this repository in a subfolder of your application and make a
+symlink to the `infection` script in the toplevel of your project.
+
+If your repository also have a `dotfiles` and the `metadot` code is also
+a subfolder, your dotfiles will be also managed by `infection`.
+
+Using in an existing distribution
+---------------------------------
+
+**WARNING:** running `infection` might replace your existing configuration with
+my defaults. You probably don't want to do that, except if you like my config.
+If you just want to use my scripts, skip the rest of this file.
+
+If you want to use `infection` with your own config, feel free to change things
+the way it best fits your taste.
+
+If you want to use all all my applications and dotfiles, replacing your
+existing configuration with mine, simply run
+
+ $HOME/apps/infection install --all --deps
+
+Once installed locally, you can sincronize this config to a remote host using
+rsync+ssh:
+
+ infection deploy <hostname>
+
+This commands uses rsync to send all contents of your `$HOME/apps` and
+`$HOME/.dotfiles` to a remote server, so please do not add personal or
+sensitive stuff in those places. Then it makes sure your dotfiles are properly
+linked.
+
+Updating
+--------
+
+You can fetch updates in this repository using
+
+ infection fetch
+
+This commands don't automatically update your working copy. Instead, it just
+does a git fetch in the `remotes/origin` repository and display it's last
+commit log including git signature.
+
+You can check version differences using `infection version` and also standard
+git commands such as `git-log(1)`. Once you're satisfied and want to apply
+changes to the current working copy including updating and initializing
+submodules, type
+
+ infection merge