https://github.com/kyure-a/el-project

Generate project skeleton for Emacs Lisp
https://github.com/kyure-a/el-project

elisp emacs emacs-lisp project-template

Last synced: about 1 month ago
JSON representation

Generate project skeleton for Emacs Lisp

• Host: GitHub
• URL: https://github.com/kyure-a/el-project
• Owner: Kyure-A
• License: gpl-3.0
• Created: 2023-12-27T06:43:50.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-02-28T17:34:30.000Z (12 months ago)
• Last Synced: 2024-11-12T21:44:58.997Z (3 months ago)
• Topics: elisp, emacs, emacs-lisp, project-template
• Language: Emacs Lisp
• Homepage:
• Size: 50.8 KB
• Stars: 17
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
[[file:LICENSE][https://img.shields.io/github/license/Kyure-A/el-project.svg?style=flat-square]]

* el-project: Generate project skeleton for Emacs Lisp

This project is inspired by [[https://github.com/fukamachi/cl-project][fukamachi/cl-project]].

** Installations

Push the following list to package-archives and install from package.el.

#+begin_src emacs-lisp

  ("kelpa" . "https://kelpa.kyre.moe/")

#+end_src

Alternatively, downloaders such as el-get, straight.el can be used.

** Usage

#+begin_src console

M-x el-project:make-project

#+end_src

When this command is executed, questions about the project are displayed interactively in the echo area. Simply follow this and enter the project information to complete the project template.

You can also change the skeleton reference to your customized skeleton by changing ~el-project:default-skeleton-dir~.

** Features

- Flexible templates

  el-project uses parameter embedding with [[https://github.com/magnars/s.el][s.el]]. Therefore, the output can be flexibly varied simply by changing the skeleton (see "[[file:skeleton/][el-project/skeleton]]").

- Multiple choices of package development tools.

  - [[https://github.com/emacs-eask/cli][Eask]]

  - [[https://github.com/cask/cask][Cask]]

  - [[https://github.com/conao3/keg.el][Keg]]

- Multiple choices of README formats

  - README.org

  - README.md

** License

This package is licensed by The GNU General Public License verson 3 or later. See [[file:LICENSE][LICENSE]].