diff options
author | Yuchen Pei <id@ypei.org> | 2023-06-26 16:02:49 +1000 |
---|---|---|
committer | Yuchen Pei <id@ypei.org> | 2023-06-26 16:02:49 +1000 |
commit | 30b349d43c1483c7608a020460b535cc0fb29ec1 (patch) | |
tree | 1469932c9d4f8cbb18593bcb4b48b3910b191075 /README.org | |
parent | ea1e815c3dc1781aa5cb6d401e233c73fa8a108b (diff) |
Adding license files and updating readmes
* COPYING.agpl3: agpl3 license file
* README.org: added readme for the repo
* emacs/.emacs.d/init/ycp-editing.el: fix hook names
* emacs/.emacs.d/init/ycp-project.el: include `my-licenses' in local-config
* emacs/.emacs.d/lisp/my/my-editing.el: fix insert pair prompt
* emacs/README.org: Move acknowledgement to the main readme; fix
verbatim to code. Add instruction on local-config generation
* manual/README.org: minor change
Diffstat (limited to 'README.org')
-rw-r--r-- | README.org | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..45f7ec2 --- /dev/null +++ b/README.org @@ -0,0 +1,35 @@ +#+title: Yuchen Pei's dotfiles +#+author: Yuchen Pei +#+language: en + +Here you can find my dotfiles. The =emacs= and =misc= directories can +be deployed using GNU Stow: + +#+begin_src shell +stow -t ~ emacs +stow -t ~ misc +#+end_src + +Acknowledgement: configs in this repo is influenced by configs from +many people, including: + +- [[https://git.sr.ht/~protesilaos/dotfiles][Protesilaos Stavrou]] +- [[https://depp.brause.cc/dotemacs.git][wasamasa]] +- [[https://depp.brause.cc/dotemacs.git][John Wiegley]] + +The directories are organised as follows: + +- The =emacs= directory :: My emacs init files, including packages not + available on (Non)GNU ELPA mostly as submodules. See the + [[file:emacs/README.org][=README.org=]] therein. +- The =misc= directory :: All non-emacs configs that can be ~stow~'d + to the home directory, including for things like i3, rofi, bash, X11 + etc. +- The =manual= directory :: All things that requires more than just an + invocation of GNU Stow, including firefox extension. +- The =mariadb-server= directory :: dir local files for mariadb + development, to be moved to a separate repo. + +Unless otherwise specified, everything is licensed under the GNU +Affero General Public License, Version 3 or later. You may find a +license file in the root directory. |