functionreturnfunction / dashboard-project-status

Display the status of a git project in emacs-dashboard
4 stars 4 forks source link
dashboard emacs git

If magit is installed, a link to the project in magit will be provided as well.

** Screenshot [[./screenshot.png]]

** Installation / Usage

*** use-package

+begin_src emacs-lisp

(use-package dashboard :config (use-package dashboard-project-status :config (add-to-list 'dashboard-item-generators `(project-status . ,(dashboard-project-status your directory))) (add-to-list 'dashboard-items '(project-status) t) (setq dashboard-items '((project-status . 10) (recents . 10) (agenda . 10)))) (dashboard-setup-startup-hook))

+end_src

*** Without use-package

+begin_src emacs-lisp

;; some time before calling dashboard-setup-startup-hook': (reqiure 'dashboard-project-status) (add-to-list 'dashboard-item-generators (project-status . ,(dashboard-project-status your directory))) (add-to-list 'dashboard-items '(project-status) t) (setq dashboard-items '((project-status . 10) (recents . 10) (agenda . 10)))

+end_src

*** Auto-Refresh Project Setting the optional second argument UPDATE for `dashboard-insert-project-status' anything non-nil will cause the project to be refreshed automatically using "git remote update".