luxick/.emacs.d
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Marcel Fries
2020-02-17 11:28:00 +01:00
parent dbd62e66bf
commit 3e4e68e475
1 changed files with 13 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.org
View File

@@ -1,28 +1,21 @@
#+OPTIONS: toc:nil #+OPTIONS: toc:nil
* Emacs Configuration * Emacs Configuration
This repository contains my configuration files for the emacs editor. This repository contains my configuration files for the emacs editor.
** About this config ** About this config
This configuration uses a literate programming style to make maintaining an emacs configuration easier. This configuration uses a literate programming style to make maintaining an emacs configuration easier.
The main configuration is performed in the ~setup-emacs.org~ file. The main configuration is performed in the ~setup-emacs.org~ file.
** Using this config ** Using this config
To use this configuration, all you need to do is save this respoitory as your ~.emacs.d~ folder and restart emacs. To use this configuration, all you need to do is save this respoitory as your ~.emacs.d~ folder and restart emacs.
#+BEGIN_SRC bash #+BEGIN_SRC bash
git clone "https://github.com/luxick/emacs-config.git" ~/.emacs.d git clone "https://github.com/luxick/emacs-config.git" ~/.emacs.d
#+END_SRC #+END_SRC
*** Customization *** Customization
The configurations contains some settings specific to my workflow/preferences. Those should be changed before starting to use emacs. The configurations contains some settings specific to my workflow/preferences. Those should be changed before starting to use emacs.
**** Org Folder Locations **** Org Folder Locations
I have a folder named ~Notes~ in my home dir which serves as a central spot for all my org related files. I have a folder named ~Notes~ in my home dir which serves as a central spot for all my org related files.
This is reflected in serval variables in ~setup-emacs.org~. If this is not what you want you will have to search for all occurences of the folder name and replace them by hand. This is reflected in serval variables in ~setup-emacs.org~. If this is not what you want you will have to search for all occurences of the folder name and replace them by hand.
**** Personal Information **** Personal Information
/TODO This is still in the config file. It sould be in somethig like a secrets.el file/ All personal information, that emacs should use (username, e-mail address, etc.) should be written into the ~personal.el~ file
** Notable Features ** Notable Features
*** Inlining CSS into Org HTML exports *** Inlining CSS into Org HTML exports
The ~org-css~ folder contains some CSS files for better looking HTML org exports. The ~org-css~ folder contains some CSS files for better looking HTML org exports.