diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e04a56..a89d42f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,21 @@ -# Contributing +# Contributing You're welcome to contribute to the [code](#contributing-to-the-code) or to the [translations](#contributing-to-the-translations)! +--- + +## Table of contents + +- [Contributing to the code](#contributing-to-the-code) + - [Coding style](#coding-style) + - [Copyright notice](#copyright-notice) + - [Themes and unit tests](#themes-and-unit-tests) +- [Contributing to the translations](#contributing-to-the-translations) + - [Updating an existing translation](#updating-an-existing-translation) + - [Adding a new translation](#adding-a-new-translation) + +--- + ## Contributing to the code You'll need `make` and [NPM](https://www.npmjs.com/) to install the development dependencies: diff --git a/README.md b/README.md index 5c40e00..043bb6f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Night Theme Switcher +# Night Theme Switcher ![](./res/screenshot.png) @@ -7,6 +7,19 @@ Automatically toggle your light and dark GTK, GNOME Shell, icon and cursor theme Supports Night Light, Location Services, manual schedule and on-demand switch. +--- + +## Table of contents + +- [Theme compatibility](#theme-compatibility) + - [GTK themes](#gtk-themes) + - [Shell themes](#shell-themes) +- [Graphical installation](#graphical-installation) +- [Command line installation](#command-line-installation) +- [Contributing](#contributing) + +--- + ## Theme compatibility These themes have been tested and work out of the box without any configuration. Other themes might work as well, let me know if there is a specific theme you'd like supported! And you can also manually set your day and night variants.