README

README for eselect
==================

Authors
-------

See the AUTHORS file.

Documentation
-------------

See ``doc/``. Use ``make html`` for HTML versions.

Copyright
---------

eselect is Copyright (c) 2005-2018 Gentoo Foundation. This code is
distributed under the terms of the `GNU General Public License,
version 2 or later`__.

The documentation in the ``doc/`` directory is dual-licensed. It can
be distributed either under the above terms, or (at your option) under
the `Creative Commons Attribution-ShareAlike 3.0 Unported License`__.

__ http://www.gnu.org/licenses/gpl-2.0
__ http://creativecommons.org/licenses/by-sa/3.0/

Style Notes
-----------

* Always use ``[[ brackets ]]``, never `[ brackets ]`.
* Use quotes on variables where necessary.
* For all source files, the same indenting rules apply as for ebuilds:
  one tab per indent level, with each tab representing 4 places.
* Avoid lines wider than 79 positions.
* Public functions don't get the ``es_`` prefix, private functions do.
* eval is evil, so we disabled it.
* Absolute paths to executables are not portable, so don't use them.


.. Local Variables:
.. mode: rst
.. fill-column: 72
.. indent-tabs-mode: nil
.. End:

.. vim: set ft=glep tw=72 sw=4 et spell spelllang=en :