From d0c5a60c32c8736fee0675267275a9cac127b01b Mon Sep 17 00:00:00 2001 From: Silvio Rhatto Date: Tue, 21 Mar 2017 19:20:25 -0300 Subject: Adds better goal and usage information Enhance README by adding more information about why and how to use the repository. --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0fd3e93..288eaa7 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ -Rhatto's default apps -===================== +Rhatto's locally-installed applications +======================================= -These repo contains submodules with basic applications to be easily -deployed in your home folder of whichever system you have access to. +This repository hosts applications I keep installed locally inside my home +directory. Some of these applications also manages my configurations such as +dotfiles. + +It is my starting point to keep all my configuration centralized in a single +versioned tree, so if I need to setup an account in a new machine -- be it +a server or personal computer -- I just need to clone this little thing and +run a couple commands to have my usual configuration ready to use. + +If you don't like my config -- which might be the case as this kind of +stuff is so personal -- you still can use my approach to do the same +management with your own stuff. Installation ------------ @@ -15,17 +25,39 @@ Then check the source integrity of the latest release: /usr/bin/git -C $HOME/apps verify-commit HEAD -Then add each subfolder from the `apps` repository to your `$PATH` depending on which projects you want to use. +Note that `/usr/bin/git` is called to avoid any other `git` wrappers or aliases +you might have available on your shell. Inception --------- -A more radical approach takes over of all your environment (shell and desktop experience): +To use a project distributed by this repository simply add it's folder into +your `$PATH`. + +If you want to use all all my applications and dotfiles, replacing your +existing configuration with mine, simply run $HOME/apps/inception install --all --deps -Once installed locally, you can deploy remotelly using rsync+ssh: +Once installed locally, you can sincronize this config to a remote host using +rsync+ssh: inception deploy -You should have a nice workspace now :) +Folder structure +---------------- + +This repository also plays well with the following `$HOME` folder structure: + + apps: this repository + code: other software projects + data: media assets (git-annex and other repositories) + file: other, non-software projects + load: download area + mail: maildir + temp: temporary folder + +Note the all folder names have: + +* The same lenght so I get free alignment on lists. +* Lowercase characters to save typing. -- cgit v1.2.3