Unverified Commit dbefeb28 authored by Matthew Zeng's avatar Matthew Zeng Committed by GitHub
Browse files

Merge pull request #309 from HollowMan6/master 

Add instructions to use EAF in chemacs
parents 80e2ed49 44eabff4

README.md

+28 −0
Original line number Diff line number Diff line
@@ -81,6 +81,34 @@ If you use [use-package](https://github.com/jwiegley/use-package), a sample conf 
  (eaf-bind-key take_photo "p" eaf-camera-keybinding))

```



---



If you use [Chemacs](https://github.com/plexus/chemacs), a sample `init.el` is provided as follows:



```Elisp

;; An example of init.el



(defun add-subdirs-to-load-path (dir)

  "Recursive add directories to `load-path'."

  (let ((default-directory (file-name-as-directory dir)))

    (add-to-list 'load-path dir)

    (normal-top-level-add-subdirs-to-load-path)))

(add-subdirs-to-load-path "~/.emacs.d/")



(require 'eaf)

```



During EAF installation, you only need to modify the parameter value when calling function `add-subdirs-to-load-path`, change it into your full path to the EAF installation directory. The sample gives a situation when you install EAF at `~/.emacs.d/`.



After EAF installation, let's assume your EAF installation directory is `~/eaf`, you only have Emacs configurations at `~/.emacs.d` and EAF installed on your computer, and you have installed Chemacs, then the `.emacs-profiles.el` should look like this:



```Elisp

(("default" . ((user-emacs-directory . "~/.emacs.d")))

 ("EAF" . ((user-emacs-directory . "~/eaf"))))

```



When you want to use EAF by chemacs, you can excute `emacs --with-profile EAF` in the terminal.



### Dependency List

Packages listed as **Core** are mandatory for EAF to work, whereas other packages are optional - install if you want to use corresponding EAF Application.

README.zh-CN.md

+28 −0
Original line number Diff line number Diff line
@@ -81,6 +81,34 @@ git clone https://github.com/manateelazycat/emacs-application-framework.git --de 
  (eaf-bind-key take_photo "p" eaf-camera-keybinding))

```



---



如果你使用[Chemacs](https://github.com/plexus/chemacs)， 下面是一份 `init.el`的配置示例：



```Elisp

;; An example of init.el



(defun add-subdirs-to-load-path (dir)

  "Recursive add directories to `load-path'."

  (let ((default-directory (file-name-as-directory dir)))

    (add-to-list 'load-path dir)

    (normal-top-level-add-subdirs-to-load-path)))

(add-subdirs-to-load-path "~/.emacs.d/")



(require 'eaf)

```



在安装EAF时，你仅需要修改此文件中调用函数`add-subdirs-to-load-path`的参数值，将其更改为你的EAF安装位置的绝对路径。 配置示例中的EAF是安装在`~/.emacs.d/`.



在EAF安装完成后，假设你将它安装到了`~/eaf`,你电脑中只有存放在`~/.emacs.d`的Emacs配置文件和安装的EAF，并且你电脑中安装了Chemacs，此时`.emacs-profiles.el`应该这样配置:



```Elisp

(("default" . ((user-emacs-directory . "~/.emacs.d")))

 ("EAF" . ((user-emacs-directory . "~/eaf"))))

```



当你想使用Chemacs打开EAF，只需在终端中执行`emacs --with-profile EAF`。



### 依赖列表

**核心** 分类代表必备依赖，这些包必须安装好EAF才能工作。其余依赖都可选，若想其使用对应的应用时，你才需要安装这些依赖。当然我们推荐先把所有依赖都安装好，等到真正使用的时候就不用再次折腾。