[gentoo-commits] proj/emacs-ebuild-snippets:master commit in: /

["Maciej Barć" <xgqt@gentoo.org>]

commit:     694dd977f189ba5028b301411eea9eb56fb0c71c
Author:     Maciej Barć <xgqt <AT> gentoo <DOT> org>
AuthorDate: Tue Mar 14 20:41:00 2023 +0000
Commit:     Maciej Barć <xgqt <AT> gentoo <DOT> org>
CommitDate: Tue Mar 14 20:41:00 2023 +0000
URL:        https://gitweb.gentoo.org/proj/emacs-ebuild-snippets.git/commit/?id=694dd977

README.md: add README.md

Signed-off-by: Maciej Barć <xgqt <AT> gentoo.org>

 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

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