From acf7e0ba424f3d90d7c80eb552d61e3c4ca97759 Mon Sep 17 00:00:00 2001 From: MT Date: Sun, 10 Nov 2019 14:55:34 -0500 Subject: [PATCH] Update README --- README.md | 382 +++++++++++++++++++++--------------------- site-elisp/multi-term | 2 +- 2 files changed, 192 insertions(+), 192 deletions(-) diff --git a/README.md b/README.md index d9e10d63..0a660edf 100644 --- a/README.md +++ b/README.md @@ -1,107 +1,107 @@ - + # M-EMACS # Table of Contents :TOC_2_ORG: -- [M-EMACS](#org9976ad2) -- [About EMACS](#org5600057) -- [About M-EMACS](#org69c425b) - - [Screenshot](#orgd2d2574) - - [About README](#orgd2a7d11) - - [Installation](#org7125077) - - [Modification](#org867435b) - - [Contribution](#orgcf522ee) - - [Special Thanks](#org5280545) -- [Startup](#org01bcb37) - - [Lexical Binding](#org7639e05) - - [Early Init](#orge418f60) - - [Garbage Collection](#orgf9c7e0c) - - [Load Path](#orgd31c710) - - [Define Constants](#orge880562) -- [Package Management](#org0fd85f8) - - [Melpa Packages](#org5a4f44f) - - [Non-Melpa Packages](#org5878f22) - - [Configure Package Manager](#org7d7e5e7) - - [Use Package](#org9f226f3) - - [Auto Package Update](#org8e88613) - - [Diminish](#org39214d6) - - [GNU Elpa Keyring Update](#org922e076) -- [Global Functionalities](#org0c1a463) - - [User Information](#org73d2693) - - [Bindings](#org6eda070) - - [Ivy, Amx, Counsel, Swiper](#org545729c) - - [Color Ripgrep](#org40ed96f) - - [Snails](#orgefb50dd) - - [Avy](#org4b86e9a) - - [Winner](#org78b5afb) - - [Which Key](#org108f0b4) - - [Popup Kill Ring](#org154d7a9) - - [Undo Tree](#org271d3ff) - - [Discover My Major](#org32a3ef4) - - [Ace Window](#orgc85769b) - - [Shells](#orgec2246f) - - [Files Directories](#org47a7b72) - - [Configs](#org4467ddc) - - [Functions](#orgda5aac7) -- [User Interface Enhancements](#org5b2c24f) - - [Doom Themes](#orgf500299) - - [Doom Modeline](#orgd576f8b) - - [Dashboard](#orga82c151) - - [Fonts and Icons](#org1cef756) - - [Smooth Scrolling](#org594d3a5) - - [Prettify Symbols](#org01b98a5) - - [UI Configs](#org3acb6ff) -- [General Programming](#org22aed36) - - [Magit](#orgf35223d) - - [Projectile](#orgb5a3603) - - [Treemacs](#org06a4434) - - [YASnippet](#org4949e80) - - [Flycheck](#orgffcc35c) - - [Dumb Jump](#org95f0db9) - - [Parenthesis](#org00cd448) - - [Indentation](#orgd011b62) - - [Quickrun](#org768c1b0) - - [Format All](#org2a30600) - - [Evil Nerd Commenter](#orgbfb16e5) - - [Editing](#orgdfefaed) - - [Headers](#org0b0e901) - - [Jupyter Notebook](#org71a6919) - - [LSP](#orgddd7a0c) - - [DAP](#org56b8300) - - [Company](#org858ccc7) -- [Programming](#orge02546b) - - [Java](#orgfeeb367) - - [C/C++/Objective C](#orgdb632fd) - - [Golang](#org573cf1c) - - [Python](#orgd695459) - - [Arduino](#org5b1db2e) - - [ESS](#org1aeec2d) - - [TeX](#orge687ef6) -- [Web Development](#orgf838f5d) - - [Web Mode](#org6a6092b) - - [JavaScript/TypeScript](#org10a24d5) - - [Emmet](#org46c3c95) - - [Instant Rename Tag](#org321b2d5) - - [JSON](#orgd2819b5) -- [Miscellaneous](#org1f9eb90) - - [Org](#org3aa8eda) - - [EAF](#orgd0e572e) - - [ERC](#org8208bee) - - [EWW](#org3753557) - - [Tramp](#orgf1ecb8b) - - [PDF Tools](#org1f9d43f) - - [LeetCode](#org1024161) - - [Pyim](#orgb168d2d) - - [EPaint](#org7da1a37) - - [Tetris](#org389d258) - - [Speed Type](#org56c09dd) - - [2048 Game](#org60ef51f) - - [Zone](#orgebbce98) - - - +- [M-EMACS](#org3af69c9) +- [About EMACS](#org6e947be) +- [About M-EMACS](#orgc56c93a) + - [Screenshot](#org41de511) + - [About README](#org22bc32e) + - [Installation](#orgd6699cf) + - [Modification](#orgcff9b87) + - [Contribution](#org402692f) + - [Special Thanks](#org790fd72) +- [Startup](#org391684b) + - [Lexical Binding](#orgab03cdd) + - [Early Init](#orgf3e0e84) + - [Garbage Collection](#orgd425668) + - [Load Path](#org2125026) + - [Define Constants](#org86b1716) +- [Package Management](#org8608878) + - [Melpa Packages](#orgb5a59ae) + - [Non-Melpa Packages](#org06f5a06) + - [Configure Package Manager](#org4a70801) + - [Use Package](#org9cb5fdf) + - [Auto Package Update](#org420f990) + - [Diminish](#org24feca8) + - [GNU Elpa Keyring Update](#org4ea69bf) +- [Global Functionalities](#orgc2761de) + - [User Information](#org45926c2) + - [Bindings](#org0c50e16) + - [Ivy, Amx, Counsel, Swiper](#orgb65954e) + - [Color Ripgrep](#org7afc889) + - [Snails](#org9f26694) + - [Avy](#org0b6e52f) + - [Winner](#org6e9437f) + - [Which Key](#orge2b2e21) + - [Popup Kill Ring](#orgb34e9f3) + - [Undo Tree](#orgc0fcd18) + - [Discover My Major](#org36f157d) + - [Ace Window](#org698ee8f) + - [Shells](#orga8fb792) + - [Files Directories](#org10503bb) + - [Configs](#org62f7d8e) + - [Functions](#org049d9f6) +- [User Interface Enhancements](#org8ed284a) + - [Doom Themes](#org9072e76) + - [Doom Modeline](#org23dc23d) + - [Dashboard](#org35e500c) + - [Fonts and Icons](#org05b61dd) + - [Smooth Scrolling](#orgbb3f803) + - [Prettify Symbols](#org8be922d) + - [UI Configs](#orgcd20eb0) +- [General Programming](#org49ba6c7) + - [Magit](#org7f7ddcd) + - [Projectile](#orgeeda9d4) + - [Treemacs](#orgfba767f) + - [YASnippet](#org1ddce40) + - [Flycheck](#org317a73d) + - [Dumb Jump](#org1f71219) + - [Parenthesis](#org2d9d39b) + - [Indentation](#org5211a59) + - [Quickrun](#org8a8ccdf) + - [Format All](#org9df6fc0) + - [Evil Nerd Commenter](#orgbaf142b) + - [Editing](#orgbdb17d8) + - [Headers](#orgdf12651) + - [Jupyter Notebook](#orgc136a0f) + - [LSP](#org0aa0274) + - [DAP](#orgb82829f) + - [Company](#orge8aee61) +- [Programming](#org85cc900) + - [Java](#org0d64edf) + - [C/C++/Objective C](#org6e30125) + - [Golang](#orgdf5d53b) + - [Python](#orga7fdc5d) + - [Arduino](#orgfb4cfda) + - [ESS](#org16c538b) + - [TeX](#orged3aaee) +- [Web Development](#org2d83a2f) + - [Web Mode](#org2b45d7d) + - [JavaScript/TypeScript](#orgc577ab1) + - [Emmet](#orgc5d5d6a) + - [Instant Rename Tag](#org5a0e367) + - [JSON](#org9601cc9) +- [Miscellaneous](#orgb04661a) + - [Org](#org84b947d) + - [EAF](#org3593663) + - [ERC](#orgc4dfafb) + - [EWW](#orgd7ee202) + - [Tramp](#orgfa206dc) + - [PDF Tools](#orgabc7d94) + - [LeetCode](#orga471087) + - [Pyim](#org8a551e3) + - [EPaint](#org1fe56c7) + - [Tetris](#org9bf4fdf) + - [Speed Type](#org006f24e) + - [2048 Game](#org191ab38) + - [Zone](#org47225b3) + + + # About EMACS @@ -132,7 +132,7 @@ Emacs doesn't have a monopoly on good ideas, and there are other great tools out *This beautifully written **About EMACS** section credits to [Remacs](https://github.com/remacs/remacs).* - + # About M-EMACS @@ -143,21 +143,21 @@ As a young EMACSer, I have experienced the struggle to find a detailed configura This configuration is designed and tested for **GNU Emacs 26.1 and above only**. However, it is suggested to use **emacs27**, the latest version currently available. - + ## Screenshot ![img](images/Sample.png) - + ## About README This README is originated from init.org that is generated using `M-x org-gfm-export-to-markdown`. Every block of code is generated through this function - it exports the section of code from the `elisp/` directory. You will not see their presence in init.org. - + ## Installation @@ -204,7 +204,7 @@ I will be updating M-EMACS from time to time, it is best to `git pull` once a wh Please also execute `git submodule update --recursive --remote` to sync with all the submodules. - + ## Modification @@ -222,14 +222,14 @@ However, what is *free* stays *free*. After all, this is [GPL](LICENSE). 6. Call `M-x org-gfm-export-to-markdown` to update `README.md` automatically. - + ## Contribution If you spotted a bug or you have any suggestions, please fill in an issue. If you have something to fix, feel free to create a pull request. - + ## Special Thanks @@ -240,12 +240,12 @@ Everyone starts somewhere, and I started here. - [Poncie Reyes's .emacs.d](https://github.com/poncie/.emacs.d) - + # Startup - + ## Lexical Binding @@ -258,7 +258,7 @@ Use lexical-binding. [Why?](https://nullprogram.com/blog/2016/12/22/) ``` - + ## Early Init @@ -330,7 +330,7 @@ It will be faster to disable them here before they've been initialized. ``` - + ## Garbage Collection @@ -383,7 +383,7 @@ If you experience freezing, decrease this. If you experience stuttering, increas ``` - + ## Load Path @@ -407,7 +407,7 @@ Since all the configuration files are stored in `elisp/` folder, they need to be ``` - + ## Define Constants @@ -471,14 +471,14 @@ Since all the configuration files are stored in `elisp/` folder, they need to be ``` - + # Package Management Some packages are disabled with the `:disabled` tag, because I don't use them very often. They might not work. - + ## Melpa Packages @@ -498,7 +498,7 @@ Configure package archives, where to install online packages and add them to `lo ``` - + ## Non-Melpa Packages @@ -523,7 +523,7 @@ git submodule update ``` - + ## Configure Package Manager @@ -539,7 +539,7 @@ git submodule update ``` - + ## Use Package @@ -565,7 +565,7 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ``` - + ## Auto Package Update @@ -584,7 +584,7 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ``` - + ## Diminish @@ -595,7 +595,7 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ``` - + ## GNU Elpa Keyring Update @@ -608,12 +608,12 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ``` - + # Global Functionalities - + ## User Information @@ -625,7 +625,7 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ``` - + ## Bindings @@ -647,7 +647,7 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ``` - + ## Ivy, Amx, Counsel, Swiper @@ -670,7 +670,7 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ("C-r" . ivy-previous-line-or-history) ("M-RET" . ivy-immediate-done)) (:map counsel-find-file-map - ("M-~" . counsel-goto-local-home))) + ("C-~" . counsel-goto-local-home))) :custom (ivy-use-virtual-buffers t) (ivy-height 10) @@ -686,7 +686,7 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ``` - + ## Color Ripgrep @@ -702,7 +702,7 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ``` - + ## Snails @@ -738,7 +738,7 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ``` - + ## Avy @@ -758,7 +758,7 @@ My Emacs configuration is almost entirely dependant on [use-package](https://git ``` - + ## Winner @@ -784,7 +784,7 @@ Winner, a mode to restore previous window layouts. ``` - + ## Which Key @@ -801,7 +801,7 @@ Winner, a mode to restore previous window layouts. ``` - + ## Popup Kill Ring @@ -813,7 +813,7 @@ Winner, a mode to restore previous window layouts. ``` - + ## Undo Tree @@ -827,7 +827,7 @@ Winner, a mode to restore previous window layouts. ``` - + ## Discover My Major @@ -839,7 +839,7 @@ Winner, a mode to restore previous window layouts. ``` - + ## Ace Window @@ -851,7 +851,7 @@ Winner, a mode to restore previous window layouts. ``` - + ## Shells @@ -910,7 +910,7 @@ Winner, a mode to restore previous window layouts. ``` - + ## Files Directories @@ -1021,7 +1021,7 @@ Dired, the directory editor. ``` - + ## Configs @@ -1146,7 +1146,7 @@ Use UTF-8 as much as possible with unix line endings. ``` - + ## Functions @@ -1345,12 +1345,12 @@ Otherwise the function displays `buffer-name'." ``` - + # User Interface Enhancements - + ## Doom Themes @@ -1369,7 +1369,7 @@ Otherwise the function displays `buffer-name'." ``` - + ## Doom Modeline @@ -1388,7 +1388,7 @@ Otherwise the function displays `buffer-name'." ``` - + ## Dashboard @@ -1463,7 +1463,7 @@ Use either `KEC_Dark_BK.png` or `KEC_Light_BK.png` depends on the backgrond them ``` - + ## Fonts and Icons @@ -1530,7 +1530,7 @@ Function to switch between fonts. ``` - + ## Smooth Scrolling @@ -1553,7 +1553,7 @@ Configurations to smooth scrolling. ``` - + ## Prettify Symbols @@ -1577,7 +1577,7 @@ Configurations to smooth scrolling. ``` - + ## UI Configs @@ -1630,12 +1630,12 @@ Display time and battery information in modeline. ``` - + # General Programming - + ## Magit @@ -1648,7 +1648,7 @@ Display time and battery information in modeline. ``` - + ## Projectile @@ -1674,7 +1674,7 @@ Display time and battery information in modeline. ``` - + ## Treemacs @@ -1757,7 +1757,7 @@ Display time and battery information in modeline. ``` - + ## YASnippet @@ -1791,7 +1791,7 @@ Display time and battery information in modeline. ``` - + ## Flycheck @@ -1809,7 +1809,7 @@ Display time and battery information in modeline. ``` - + ## Dumb Jump @@ -1826,7 +1826,7 @@ Display time and battery information in modeline. ``` - + ## Parenthesis @@ -1912,7 +1912,7 @@ Match and automatically pair parenthesis, and show parenthesis even when it went ``` - + ## Indentation @@ -1951,7 +1951,7 @@ Indentation Configuration ``` - + ## Quickrun @@ -1965,7 +1965,7 @@ Indentation Configuration ``` - + ## Format All @@ -1979,7 +1979,7 @@ Indentation Configuration ``` - + ## Evil Nerd Commenter @@ -1993,7 +1993,7 @@ Indentation Configuration ``` - + ## Editing @@ -2043,7 +2043,7 @@ Indentation Configuration ``` - + ## Headers @@ -2062,7 +2062,7 @@ Indentation Configuration ``` - + ## Jupyter Notebook @@ -2082,7 +2082,7 @@ Indentation Configuration ``` - + ## LSP @@ -2142,7 +2142,7 @@ Indentation Configuration ``` - + ## DAP @@ -2174,7 +2174,7 @@ Indentation Configuration ``` - + ## Company @@ -2382,12 +2382,12 @@ This is enabled by default, if ever you find it not good enough for a particular ``` - + # Programming - + ## Java @@ -2410,7 +2410,7 @@ This is enabled by default, if ever you find it not good enough for a particular ``` - + ## C/C++/Objective C @@ -2465,7 +2465,7 @@ This is enabled by default, if ever you find it not good enough for a particular ``` - + ## Golang @@ -2484,7 +2484,7 @@ go get golang.org/x/tools/gopls@latest ``` - + ## Python @@ -2516,7 +2516,7 @@ go get golang.org/x/tools/gopls@latest ``` - + ## Arduino @@ -2551,7 +2551,7 @@ go get golang.org/x/tools/gopls@latest ``` - + ## ESS @@ -2568,7 +2568,7 @@ go get golang.org/x/tools/gopls@latest ``` - + ## TeX @@ -2617,7 +2617,7 @@ go get golang.org/x/tools/gopls@latest ``` - + # Web Development @@ -2629,7 +2629,7 @@ npm i -g typescript-language-server ``` - + ## Web Mode @@ -2646,7 +2646,7 @@ npm i -g typescript-language-server ``` - + ## JavaScript/TypeScript @@ -2673,7 +2673,7 @@ npm i -g typescript-language-server ``` - + ## Emmet @@ -2687,7 +2687,7 @@ npm i -g typescript-language-server ``` - + ## Instant Rename Tag @@ -2700,7 +2700,7 @@ npm i -g typescript-language-server ``` - + ## JSON @@ -2712,12 +2712,12 @@ npm i -g typescript-language-server ``` - + # Miscellaneous - + ## Org @@ -2823,7 +2823,7 @@ npm i -g typescript-language-server ``` - + ## EAF @@ -2861,7 +2861,7 @@ sudo apt-get install python3-pyqt5.qtwebengine python3-pyqt5.qtmultimedia ``` - + ## ERC @@ -2975,7 +2975,7 @@ machine irc.freenode.net login password ``` - + ## EWW @@ -2995,7 +2995,7 @@ Emacs Web Wowser, the HTML-based Emacs Web Browser. ``` - + ## Tramp @@ -3031,7 +3031,7 @@ Connect to Google Cloud Platform using the following: ``` - + ## PDF Tools @@ -3055,7 +3055,7 @@ Connect to Google Cloud Platform using the following: ``` - + ## LeetCode @@ -3074,7 +3074,7 @@ Connect to Google Cloud Platform using the following: ``` - + ## Pyim @@ -3118,7 +3118,7 @@ Connect to Google Cloud Platform using the following: ``` - + ## EPaint @@ -3138,7 +3138,7 @@ Connect to Google Cloud Platform using the following: ``` - + ## Tetris @@ -3157,7 +3157,7 @@ Although [Tetris](https://www.emacswiki.org/emacs/TetrisMode) is part of Emacs, ``` - + ## Speed Type @@ -3169,7 +3169,7 @@ Although [Tetris](https://www.emacswiki.org/emacs/TetrisMode) is part of Emacs, ``` - + ## 2048 Game @@ -3181,7 +3181,7 @@ Although [Tetris](https://www.emacswiki.org/emacs/TetrisMode) is part of Emacs, ``` - + ## Zone diff --git a/site-elisp/multi-term b/site-elisp/multi-term index 59f54c46..8deb0f22 160000 --- a/site-elisp/multi-term +++ b/site-elisp/multi-term @@ -1 +1 @@ -Subproject commit 59f54c4680f62b37a19587f20b7d81da10faa146 +Subproject commit 8deb0f2252399cca2426eb3cc3e9646c5de726b3