aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaciej Barć <xgqt@gentoo.org>2023-03-14 21:41:00 +0100
committerMaciej Barć <xgqt@gentoo.org>2023-03-14 21:41:00 +0100
commit694dd977f189ba5028b301411eea9eb56fb0c71c (patch)
tree620aa76b960d13e7bbe26e0900668c5bcc20f7d9
parentMakefile: add eldev-install (diff)
downloademacs-ebuild-snippets-694dd977f189ba5028b301411eea9eb56fb0c71c.tar.gz
emacs-ebuild-snippets-694dd977f189ba5028b301411eea9eb56fb0c71c.tar.bz2
emacs-ebuild-snippets-694dd977f189ba5028b301411eea9eb56fb0c71c.zip
README.md: add README.md
Signed-off-by: Maciej Barć <xgqt@gentoo.org>
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aca7562
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Emacs-Ebuild-Snippets
+
+Yasnippets for editing Ebuilds, Eclasses and Gentoo package metadata.
+
+## Installation
+
+### System
+
+If you are on Gentoo Linux, then just emerge
+`app-emacs/emacs-ebuild-snippets`.
+
+``` shell
+emerge app-emacs/emacs-ebuild-snippets
+```
+
+### User
+
+If you want to install this package under your user only then you have to use
+the Eldev tool or manually copy the `snippets` directory.
+
+``` shell
+make eldev-install
+```
+
+## Upstream
+
+Upstream can be found on the Gentoo official GitWeb:
+https://gitweb.gentoo.org/proj/emacs-ebuild-snippets.git/
+
+## License
+
+Copyright (c) 2023 Gentoo Authors
+
+Licensed under the GNU GPL v2 License
+
+SPDX-License-Identifier: GPL-2.0-or-later