aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
authorBrian Cully <bjc@kublai.com>2022-09-16 15:05:33 -0400
committerBrian Cully <bjc@kublai.com>2022-09-16 15:05:33 -0400
commit1387f030e68ecfe96c1ce7ed6bcc35a81c6df434 (patch)
tree569f4c12e5851b99d6a4fe92253d2470877a3047 /README.org
downloadtramp-docker-1387f030e68ecfe96c1ce7ed6bcc35a81c6df434.tar.gz
tramp-docker-1387f030e68ecfe96c1ce7ed6bcc35a81c6df434.zip
Docker support for Tramp.
Slightly modified copy of ‘tramp-nspawn’.
Diffstat (limited to 'README.org')
-rw-r--r--README.org28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..f9a4988
--- /dev/null
+++ b/README.org
@@ -0,0 +1,28 @@
+* Introduction
+=tramp-docker= adds support for =Docker= containers with Emacs’
+Tramp system.
+
+* Installation
+** ELPA
+This package is available on [[https://elpa.gnu.org/packages/nspawn-tramp.html][GNU ELPA]] and can be installed with
+=M-x package-install RET tramp-docker RET= from within Emacs itself.
+
+** Direct download
+Download this repository to some location, then add the following to
+your Emacs initialization:
+#+begin_src elisp
+ (add-to-list 'load-path "/path/to/tramp-docker")
+ (require 'tramp-docker)
+#+end_src
+
+* Usage
+Call ~tramp-docker-setup~ to add support:
+#+begin_src elisp
+ (add-hook 'after-init-hook 'tramp-docker-setup)
+#+end_src
+
+
+Use Tramp as normal to access files on a container:
+#+begin_example
+ C-x C-f /docker:user@container:/path/to/file
+#+end_example