rename to multi-emacs-config

init/multi-emacs-config.el

@@ -1,19 +1,24 @@
-;;; dot.emacs  --- Summary
+;;; multi-emacs-config.el  --- A tool to use multiple emacs configurations  -*- lexical-binding: t; -*-
-;;;   This package will enable us to use multiple emacs startup
+;;
-;;;   configuration(startkit in this package) and switch between
+;; Author: Rongsong Shen<rshen@shenrs.eu>
-;;;   these configuration just by change a single environment
+;;
-;;;   variable (EMACS_STARTKIT).
-;;;
-;;;   Currently, we have test it with following:
-;;;   -  doom-emacs
-;;;   -  spacemacs
-;;;   -  frontmacs
-;;;   -  ohai-emacs
-;;;   -  graphene
-;;;   -  prelude
-;;;
 ;;; Commentary:
+
+;;   This package will enable us to use multiple EMACS startup
+;;   configuration(startkit in this package) and switch between
+;;   these configuration just by change a single environment
+;;   variable (EMACS_STARTKIT).
+;;
+;;   Currently, we have test it with following:
+;;   -  doom-emacs
+;;   -  spacemacs
+;;   -  frontmacs
+;;   -  ohai-emacs
+;;   -  graphene
+;;   -  prelude
+;;
 ;;; Code:
+
 (require 'cl-lib)
 (require 'comint)
 
@@ -96,6 +101,8 @@
 
 
 (defun install-emacs-startkit (name location)
+  "Function to install EMACS startkit. NAME is the name of EMACS startkit.
+LOCATION is the target directory which startkit will be installed."
   (progn (let* ((shell-buffer (make-comint-in-buffer "installer" nil "/bin/sh"))
                 (shell-process (get-buffer-process shell-buffer)))
            (progn
@@ -121,5 +128,5 @@ We use this function to load startkit initialization file"
                               emacs-config-directory))
   (load-file emacs-init-file))
 
-(provide 'dot.emacs)
+(provide 'multi-emacs-config)
-;;; dot.emacs.el ends here
+;;; multi-emacs-config.el ends here