Drop-down terminal for GNOME
Go to file
2021-09-09 00:29:25 -04:00
.github ci:Switch to github actions. 2021-09-07 10:05:53 +02:00
docs Update docs that mention travis to GitHub Actions 2021-09-09 09:45:59 +08:00
git-hooks update french translation 2018-01-06 00:24:31 +01:00
guake Remove unused glib import 2021-09-08 23:33:03 -04:00
po make update-po 2020-02-18 22:58:54 +01:00
releasenotes Merge pull request #1866 from ZhaoZuohong/master 2021-09-09 07:25:28 +08:00
scripts fix: Get CI to pass 2021-09-07 11:17:27 +02:00
.editorconfig add translation section in rel note and minor fixes 2018-01-06 00:59:28 +01:00
.flake8 remove unused imports 2021-09-08 23:33:03 -04:00
.gitignore Add --select-terminal and --selected-terminal options 2019-11-13 23:29:28 +01:00
.pep8rc Use pipenv, pbr 2017-10-19 17:57:37 +02:00
.pylintrc fix: Get CI to pass 2021-09-07 11:17:27 +02:00
COPYING Fixing file permissions (chmod -x) 2008-04-21 21:48:27 -03:00
MAINTAINERS Split maintainers from original author 2020-03-09 14:18:09 +01:00
Makefile Add PIPENV_IGNORE_VIRTUALENVS=1 2021-09-09 09:07:21 +08:00
MANIFEST.in Fix missing paths.py in sdist and wheel 2018-07-16 19:50:34 +02:00
NEWS.rst Release 3.7.0 2020-02-10 22:04:40 +01:00
Pipfile Add dataclasses to dev-dependencies 2021-09-09 09:08:26 +08:00
Pipfile.lock Add dataclasses to dev-dependencies 2021-09-09 09:08:26 +08:00
pyproject.toml Replace autopep8, yapf by black 2020-02-18 22:58:54 +01:00
README.rst Update build badge URL 2021-09-09 09:21:06 +08:00
requirements-dev.txt remove unneeded dependency on mock 2021-09-08 23:18:17 -04:00
requirements.txt Update translation, fix ut for multi lang, remove pyxdg deps 2019-04-18 15:15:55 +02:00
setup.cfg setup.cfg: remove obsolete line that does nothing 2021-09-09 00:29:25 -04:00
setup.py validate pip install guake 2018-06-21 01:10:32 +02:00

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

|actions-badge|_ |bountysource-badge|_ |docs-badge|_ |translation-badge|_

.. |actions-badge| image:: https://github.com/Guake/guake/actions/workflows/ci.yml/badge.svg
.. _actions-badge: https://github.com/Guake/guake/actions

.. |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 python based 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.

Quick Installation Guide
------------------------

Please refer to `Installation Guide <https://guake.readthedocs.io/en/latest/user/installing.html#system-wide-installation>`_

What it looks like ? 
--------------------

.. image:: https://i.ibb.co/s97cJWZ/guake.png
   :alt: Guake Screenshot
   :class: with-shadow
Drop down terminal on pressing <F12>

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 amount 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 components 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.

This project was originally created by Gabriel Falcão, see: https://sourceforge.net/projects/guake-gnome-vte/