aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md27
-rw-r--r--USE.md41
2 files changed, 67 insertions, 1 deletions
diff --git a/README.md b/README.md
index e637b8f..89f66ee 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
# Overview of setting profiles for accounts
-FIXME
+Shell accounts can have one or more profiles applied.
+
+shell account profiles are used to track specific files,
+either for general setup or for high-level project tracking.
+
+The tool `vcsh` is used to manage shell profiles.
+
+
+## General shell setup
+
+...
+
+Example profiles:
+
+ * mail
+ * design-graphics
+ * design-web
+
+
+## Project tracking
+
+Example profiles:
+
+ * REDPILL - sub-projects part of the Redpill project
+ * Redpill "Features"
+ * Redpill vcsh templates
diff --git a/USE.md b/USE.md
new file mode 100644
index 0000000..6898c42
--- /dev/null
+++ b/USE.md
@@ -0,0 +1,41 @@
+# Using shell account profile
+
+
+## Status
+
+ vcsh status
+
+This shows you the profiles known to vcsh,
+and their state -
+e.g. if some settings files contain local changes not tracked.
+
+
+## Update a tracked settings file
+
+ vcsh $PROFILE commit $PATH_TO_FILE
+
+As an example,
+you have changed the configuration of your email client,
+and want to update your profile tracking -
+e.g. to distribute that change to your other shell environments.
+
+ vcsh mail commit ~/.thunderbird/profiles.ini
+
+The command is a wrapper for `git commit ...`
+and can take ordinary git options, e.g. `-m "some commit message..."`.
+
+Later when you use another shell environment
+(or when others in your organisation has done the above)
+you can apply those changes here like this:
+
+ vcsh pull
+
+In case of collision,
+vcsh will warn and you can work it out with git commands,
+where `git` is replaced by `vcsh $PROJECT`.
+
+
+## More information
+
+ vcsh help
+ man vcsh