Drop-down terminal for GNOME
Go to file
2019-04-18 15:15:55 +02:00
.github Update PULL_REQUEST_TEMPLATE.md 2018-05-09 16:14:35 +02:00
data Add terminal search box 2019-04-18 12:58:44 +02:00
docs Update installing.rst 2018-11-22 15:37:22 +01:00
git-hooks update french translation 2018-01-06 00:24:31 +01:00
guake Minor code update and error management 2019-04-18 15:15:55 +02:00
po Minor code update and error management 2019-04-18 15:15:55 +02:00
releasenotes Fix Vte-WARNING about regex flags 2019-04-18 14:03:12 +02:00
scripts Add verbose option to run-local and make run 2019-04-17 07:12:49 +02:00
.editorconfig add translation section in rel note and minor fixes 2018-01-06 00:59:28 +01:00
.flake8 quick edit: Support pytest output 2018-04-09 18:48:35 +02:00
.gitignore Update reno config 2019-04-03 15:23:07 +02:00
.pep8rc Use pipenv, pbr 2017-10-19 17:57:37 +02:00
.pylintrc update dependencies 2018-08-19 01:03:42 +02:00
.travis.yml remove xvfb start 2019-04-15 10:46:04 +02:00
.yapf make yapf 2017-10-19 17:57:38 +02:00
COPYING Fixing file permissions (chmod -x) 2008-04-21 21:48:27 -03:00
Makefile Add verbose option to run-local and make run 2019-04-17 07:12:49 +02:00
MANIFEST.in Fix missing paths.py in sdist and wheel 2018-07-16 19:50:34 +02:00
NEWS.rst Updating release note 2019-04-03 15:23:07 +02:00
Pipfile Add dep. to pyxdg 2019-04-13 06:28:48 +02:00
Pipfile.lock Add dep. to pyxdg 2019-04-13 06:28:48 +02:00
README.rst Fix link in README 2018-07-05 21:40:40 +02:00
requirements-dev.txt Update dependencies 2019-04-03 15:23:07 +02:00
requirements.txt Minor code update and error management 2019-04-18 15:15:55 +02:00
setup.cfg validate pip install guake 2018-06-21 01:10:32 +02:00
setup.py validate pip install guake 2018-06-21 01:10:32 +02:00

==============
Guake 3 README
==============

|travis-badge|_ |bountysource-badge|_ |docs-badge|_ |translation-badge|_

.. |travis-badge| image:: https://travis-ci.org/Guake/guake.svg?branch=master
.. _travis-badge: https://travis-ci.org/Guake/guake

.. |bountysource-badge| image:: https://img.shields.io/bountysource/team/guake/activity.svg
.. _bountysource-badge: https://www.bountysource.com/teams/guake

.. |docs-badge| image:: https://readthedocs.org/projects/guake/badge/?version=stable
.. _docs-badge: https://guake.readthedocs.io/en/stable/?badge=stable

.. |translation-badge| image:: https://hosted.weblate.org/widgets/guake/-/guake/svg-badge.svg
.. _translation-badge: https://hosted.weblate.org/projects/guake/guake/

Introduction
============

Guake is a dropdown terminal made for the GNOME desktop environment. Guake's style of window is
based on an FPS game, and one of its goals is to be easy to reach.

Features Request
----------------

Please vote for feature on `FeatHub <http://feathub.com/Guake/guake>`_.
Open Issues on GitHub only for bug reports.

Most requested features list for Guake:

|feathub-badge|_

.. |feathub-badge| image:: http://feathub.com/Guake/guake?format=svg
.. _feathub-badge: http://feathub.com/Guake/guake

There is also a Bountysource opened here for those willing to pay a certain among of money for a
really needed feature.
`See our Bountysource page here <https://www.bountysource.com/teams/guake>`_.

Note when compiling from source
-------------------------------

Do **NOT** use the Tarball packages automatically generated by GitHub on the Release pages. They
won't work because one of the main component of Guake build system, PBR, requires the full Git
history to be available when building from source. Note this does not impact source distribution
packages you can download from Pypi.

Build from sources instructions are described on
`this page of the Online Documentation <http://guake.readthedocs.io/en/latest/user/installing.html#install-from-source>`_.
Please read this carefully before opening an issue !

Bugs? Information?
------------------

- Source Code available on `GitHub <https://github.com/Guake/guake/>`_.
- Official Homepage: http://guake-project.org
- Online Documentation is hosted on `ReadTheDocs <http://guake.readthedocs.io/>`_.
- If you are not a developer, you can still contribute to Guake by
  `improving its translations in your language <https://hosted.weblate.org/projects/guake/guake/>`_.
  Guake users are welcome `to support Weblate <https://weblate.org/donate/>`_ in providing this
  service for free for OpenSource Projects.

**Important note**: Do **NOT** use the domain guake.org, it has been registered by someone outside
the team. We cannot be held responsible for the content on that web site.