Usage examples

diff --git a/README b/README
index 5f42e1115791d00968863dd684f62c3a16314828..bf1660d4c8830cb0d79f79073f79240a77699850 100644 (file)
--- a/README
+++ b/README
@@ -20,3 +20,5 @@ Optimizations:
 * varstash library is loaded without checking if autoenv needs it -- it
   is faster to load it anyway, than to invoke grep every time
 * ctime is used instead of mtime, without size storage (unnecessary)
+
+Look USAGE for examples.

diff --git a/USAGE b/USAGE
new file mode 100644 (file)
index 0000000..a823159
--- /dev/null
+++ b/USAGE
@@ -0,0 +1,18 @@
+Some random Python project:
+
+    proj/.autoenv.zsh:
+        autostash PATH
+        path=(~/local/stow/py310/bin $path)
+        . ~w/pyderasn-venv/bin/activate
+        export -TU PYTHONPATH pythonpath
+        pythonpath=(. src $pythonpath)
+    proj/.autoenv_leave.zsh:
+        deactivate
+
+Some random C project:
+
+    proj/.autoenv.zsh:
+        autostash LD_LIBRARY_PATH MANPATH
+        ld_library_path=(~w/libressl/lib ~w/local/lib $ld_library_path)
+        manpath=(~w/libressl/share/man $manpath)
+        autostash NSPR_LOG_MODULES=all:5 SSLDEBUG=1 SSLTRACE=125