diff --git a/source/index.rst b/source/index.rst --- a/source/index.rst +++ b/source/index.rst @@ -14,6 +14,7 @@ layout/index style/index components/index + resources/contribute .. Indices and tables @@ -23,7 +24,6 @@ * :ref:`modindex` * :ref:`search` - The Classic KDE Human Interface Guidelines (HIG) offer application designers and developers a set of recommendations for designing and developing user interfaces for QWidget-based, desktop-only applictions. Their aim is to improve the experience for users by making application interfaces more consistent and hence more intuitive and learnable. For applications which are supposed to run on both desktop and mobile systems, consult the [[../KirigamiHIG | Kirigami Human Interface Guidelines (HIG)]] diff --git a/source/resources/contribute.rst b/source/resources/contribute.rst new file mode 100644 --- /dev/null +++ b/source/resources/contribute.rst @@ -0,0 +1,20 @@ +Contribute +========== + +The HIG source code is managed using Git and is hosted on https://cgit.kde.org/websites/hig-kde-org.git/ . `Sphinx `_ is used to create HTML pages from the source files. `Phabricator `_ is used to organize tasks and todos. + +If you are new to KDE devlopment, make sure to read `how to become a kde developer `_ first. + +Getting started +--------------- + +#. Install Spinx with your distro's package manager + + * openSuse ``sudo zypper in git python3-Sphinx python3-sphinx_rtd_theme`` + * Debian/Ubuntu/KDE Neon ``sudo apt install git build-essential python3-sphinx`` + +#. Clone HIG repositories into an empty folder + ``git clone https://anongit.kde.org/websites/hig-kde-org.git`` +#. ``cd hig-kde-org.git`` +#. Run ``make html`` to create the HTML pages +#. Open ``build/html/index.html`` in your browser