diff --git a/TODO.org b/TODO.org index b1e77d01f..b743ee82d 100644 --- a/TODO.org +++ b/TODO.org @@ -5,7 +5,7 @@ + [-] Work-in-progress + [X] Complete -** Unreleased [46/123] +** Unreleased [48/123] + [1/12] Potential plugins + [ ] [[https://github.com/emacs-lsp/lsp-mode][lsp-mode]]: client for MS Language Server Protocol, keep an eye on this + [ ] lang/javascript: [[https://github.com/codesuki/add-node-modules-path][add-node-modules-path]] (adds node_modules to ~exec-path~) @@ -25,7 +25,7 @@ + [ ] app/irc + [-] app/crm + [-] app/write -+ [2/57] Add README.org's (with working babel blocks?) to modules (see [[modules/lang/go/README.org][lang/go/README.org]]) to replace bootstaps ++ [4/57] Add README.org's (with working babel blocks?) to modules (see [[modules/lang/go/README.org][lang/go/README.org]]) to replace bootstaps + [0/8] :tools + [ ] dired + [ ] electric-indent @@ -35,9 +35,9 @@ + [ ] term + [ ] tmux + [ ] upload - + [1/25] :lang + + [2/25] :lang + [ ] assembly - + [ ] cc + + [X] cc + [ ] crystal + [ ] csharp + [ ] data @@ -83,8 +83,8 @@ + [ ] company + [ ] ido + [ ] helm - + [0/5] :app - + [ ] email + + [1/5] :app + + [X] email + [ ] write + [ ] rss + [ ] twitter diff --git a/modules/app/email/README.org b/modules/app/email/README.org new file mode 100644 index 000000000..a9d0ae8d9 --- /dev/null +++ b/modules/app/email/README.org @@ -0,0 +1,50 @@ +* Email + +I want to live in Emacs, but as we all know, living is incomplete without email. +So I prayed to the text editor gods and they (I) answered. Emacs+evil's editing +combined with org-mode for writing emails? Yes please. + +It uses ~mu4e~ to read my email, but depends on ~offlineimap~ (to sync my email +via IMAP) and ~mu~ (to index my mail into a format ~mu4e~ can understand). + +#+begin_quote +My config is gmail/gsuite oriented, and since Google has its own opinions on the +IMAP standard, it is unlikely to translate to other hosts. +#+end_quote + +** Installation +*** MacOS +#+BEGIN_SRC sh :tangle (if (doom-system-os 'macos) "yes") +brew install mu --with-emacs +brew install offlineimap +#+END_SRC + +*** Arch Linux +#+BEGIN_SRC sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes") +sudo pacman --noconfirm --needed -S offlineimap mu +#+END_SRC + +** Setup +First, you need to set up, download and index your email: + +1. Write a ~\~/.offlineimaprc~. Mine can be found [[https://github.com/hlissner/dotfiles/tree/master/shell/%252Bmu][in my dotfiles repository]]. It + is configured to download mail to ~\~/.mail~. +2. Download your email: ~offlineimap -o~ (may take a while) +3. Index it with mu: ~mu index --maildir ~/.mail~ + +Then configure Emacs to use your email address: + +#+BEGIN_SRC emacs-lisp :tangle no +;; + %s is replaced with the label, e.g. /%s/Drafts => /lissner.net/Drafts +;; + Each path is relative to `+email-mu4e-mail-path', which is ~/.mail by +;; default +(set! :email "lissner.net" + '((mu4e-sent-folder . "/%s/Sent Mail") + (mu4e-drafts-folder . "/%s/Drafts") + (mu4e-trash-folder . "/%s/Trash") + (mu4e-refile-folder . "/%s/All Mail") + (smtpmail-smtp-user . "henrik@lissner.net") + (user-mail-address . "henrik@lissner.net") + (mu4e-compose-signature . "---\nHenrik Lissner")) + t) +#+END_SRC diff --git a/modules/lang/cc/README.org b/modules/lang/cc/README.org new file mode 100644 index 000000000..644ef67a9 --- /dev/null +++ b/modules/lang/cc/README.org @@ -0,0 +1,25 @@ +* C/C++/Obj-C + +I use C/C++ mostly for developing games. To that end, this module leverages the +[[https://github.com/Sarcasm/irony-mode][irony plugin]] for auto-completion, eldoc documentation and syntax checking (with +flycheck). + +Though it provides Objective-C support, I don't use it except to inspect +generated glue code for iOS mobile apps. + ++ Snippets ([[https://github.com/hlissner/emacs-snippets/tree/master/c-mode][c-mode]], [[https://github.com/hlissner/emacs-snippets/tree/master/c++-mode][c++-mode]]) ++ File templates ([[../../feature/file-templates/templates/c-mode][c-mode]], [[../../feature/file-templates/templates/c++-mode][c++-mode]]) + +** Installation +~irony-server~ is required to use irony-mode's features auto-completion (among +other things). To install it, run ~M-x irony-install-server~. + +This is all you need on Linux. + +*** MacOS +libclang is required to build irony-server. On MacOS, the best way I know of to +get it is: + +#+BEGIN_SRC sh :tangle (if (doom-system-os 'macos) "yes") +brew install llvm # may take a while! +#+END_SRC diff --git a/modules/lang/go/README.org b/modules/lang/go/README.org index 858bf0a8b..43a45b592 100644 --- a/modules/lang/go/README.org +++ b/modules/lang/go/README.org @@ -16,10 +16,10 @@ brew install go *** Arch Linux #+BEGIN_SRC sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes") -pacman --needed --noconfirm -S go +sudo pacman --needed --noconfirm -S go #+END_SRC -** Dependencies +** Setup You need to set up ~GOPATH~ before you can install lang/go's dependencies. #+BEGIN_SRC sh diff --git a/modules/ui/doom/README.org b/modules/ui/doom/README.org index b0336660c..4f39513be 100644 --- a/modules/ui/doom/README.org +++ b/modules/ui/doom/README.org @@ -6,7 +6,8 @@ plugin to thank for bringing it to Emacs. On top of that, it uses: + [[https://github.com/mozilla/Fira][Fira Mono]] (font) -+ [[https://github.com/rolandwalker/nav-flash][nav-flash]]: blinks the current line when jumping large distances, to help keep track of the cursor. ++ [[https://github.com/rolandwalker/nav-flash][nav-flash]]: blinks the current line when jumping large distances, to help keep + track of the cursor. + ~hideshow~, modified to use a nicer folded-region indicator. + Custom fringe bitmaps for ~git-gutter-fringe~ (thin bars)