diff --git a/README.md b/README.md index 9e53612..c1087ed 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ # sdf -Code that makes using SDF easier and more fun. \ No newline at end of file +Code that makes SDF easier to use and more fun with GNU Emacs + +1. Save the SDF folder to your home directory: git clone https://git.sdf.org/scm/sdf.git +2. Copy the dotemacs file in the SDF directory to your home directory: cp $HOME/sdf $HOME +3. Rename the dotemacs file to .emacs: mv $HOME/dotemacs .emacs +4. Make sure that the shell files in the sdf directory or executable. If they are not: chmod +x $HOME/sdf/*.sh +5. If you have not already, setup SSH key-based authentication to sdf.org +6. If you have not already, install mosh +7. Run Emacs +8. Select the com or bboard buffers in Emacs to use either of those programs: C-x b followed by bboard or com as the name + diff --git a/dotemacs b/dotemacs index 890946c..13ef42f 100644 --- a/dotemacs +++ b/dotemacs @@ -1,6 +1,6 @@ ;; .emacs ;; Custom GNU Emacs startup file that connects to SDF services using Bash -;; scripts +;; scripts. Rename this file to .emacs to make it your own. ;; See README.md for installation and usage details ;; Copyright (C) 2022 Scott C. MacCallum ;; scm@sdf.org @@ -38,9 +38,9 @@ (rename-buffer "term") ;; Run bboard on SDF -(ansi-term "/home/scm/sdf/bboard.sh") +(ansi-term "$HOME/sdf/bboard.sh") (rename-buffer "bboard") ;; Run com on SDF -(ansi-term "/home/scm/sdf/com.sh") +(ansi-term "$HOME/sdf/com.sh") (rename-buffer "com")