1.0: Finalised for release

Updating the README.md to bring it ready for wider release:
* Removed some points that were more implementation details
* Added Contributions section
* Simplified the usage section
* Expanded initial explanation
* Fixed steam launch command to allow the overlay to still work

Others:
* Mark as 1.0
* Update the license file for 2018

CHANGELOG

@@ -1,3 +1,11 @@
+1.0
+
+Fixed and cleaned up README file
+Config file parsing
+Man page
+Example PKGBUILD file
+Bug fix for missing pthread_rwlock_init
+
 0.2
 
 Updated meson build to improve compatibility, configuration and development
@@ -8,4 +16,4 @@ Various code style and standards related improvements
 
 0.1
 
-Initial release
+Initial release

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017, Feral Interactive
+Copyright (c) 2018, Feral Interactive
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,105 +1,87 @@
 # GameMode
+**GameMode** is a daemon/lib combo for Linux that allows games to request a set of optimisations be temporarily applied to the host OS.
 
-A preliminary implementation of a daemon/lib combo to allow games to request a performance mode from the host OS on Linux. It was designed primarily as a stop-gap solution to problems with the Intel and AMD CPU powersave or ondemand governors, but is intended to be expanded beyond just CPU power states as needed.
+The design has a clear-cut abstraction between the host daemon and library (`gamemoded` and `libgamemode`), and the client loaders (`libgamemodeauto` and `gamemode_client.h`) that allows for safe use without worrying about whether the daemon is installed or running. This design also means that while the host library currently relies on `systemd` for exchanging messages with the daemon, it's entirely possible to implement other internals that still work with the same clients.
 
-Currently using `sd-bus` on the user bus internally for messaging
+GameMode was designed primarily as a stop-gap solution to problems with the Intel and AMD CPU powersave or ondemand governors, but is intended to be expanded beyond just CPU governor states, as there are a wealth of automation tasks one might want to apply.
 
----
-## Components
-
-### Host
-#### gamemoded
-Runs in the background, waits for requests, refcounts and also checks caller PID lifetime.
-
-Accepts `-d` (daemonize) and `-l` (log to syslog)
-
-#### libgamemode
-Dynamic library to dispatch requests to the daemon
-
-Note: Behaviour of `gamemoded` may change, so `libgamemode` should never be linked with directly.
-
-#### cpugovctl
-Small program used to to control the cpu governor.
-
-Accepts `get` (gets current governor) and `set <GOVERNOR>` (sets the current governor).
-
-### Clients
-#### libgamemodeauto
-Simple dynamic library that automatically requests game mode when loaded. Minimal dependencies.
-
-Useful to `LD_PRELOAD` into any game as needed.
-
-#### gamemode\_client.h
-Very small header only lib that lets a game request game mode and handle errors. Minimal dependencies.
-
-Can also be included with `GAMEMODE_AUTO` defined to behave automatically.
+Issues with GameMode should be reported here in the issues section, and not reported to Feral directly.
 
 ---
-## Build and install
-
-### Daemon and host library
-
-#### Dependencies
-* meson
-* systemd
+## Building and installing
+GameMode depends on `meson` for building and `systemd` for internal communication. This repo contains a `bootstrap.sh` script to allow for quick install to the user bus, but check `meson_options.txt` for custom settings.
 
 ```bash
 # Ubuntu
-apt install meson libsystemd-dev pkg-config
+apt install meson libsystemd-dev pkg-config ninja-build
 # Arch
-pacman -S meson systemd
-```
+pacman -S meson systemd ninja
 
-```bash
-git clone <git repo>
+git clone https://github.com/FeralInteractive/gamemode.git
 cd gamemode
 ./bootstrap.sh
 ```
 
 ---
-## Using with any game or program
+## Requesting GameMode
 
-After installing `libgamemodeauto.so` simple preload it into the program. Examples:
+### Users
+After installing `libgamemodeauto.so` simply preload it into the game:
 ```bash
 LD_PRELOAD=/usr/\$LIB/libgamemodeauto.so ./game
 ```
-Or steam launch options
-```bash
-LD_PRELOAD=/usr/\$LIB/libgamemodeauto.so %command%
+Or edit the steam launch options:
+```
+LD_PRELOAD=$LD_PRELOAD:/usr/\$LIB/libgamemodeauto.so %command%
 ```
 
----
-## Building into a game or program
-
-You may want to build in functionality directly into an app, this stops the need for users to have to manually set anything up.
-
-`gamemode_client.h` and `libgamemodeauto` are safe to use regardless of whether libgamemode and gamemoded are installed on the system. They also do not require `systemd`.
+### Developers
+You may want to build the request directly into an app. Note that none of these client methods force your users to have the daemon installed or running - they will safely no-op if the host is missing.
 
-### Using directly
+#### Explicit requests
 ```C
 #include "gamemode_client.h"
 
-	if( gamemode_request_start() < 0 )
+	if( gamemode_request_start() < 0 ) {
 		fprintf( stderr, "gamemode request failed: %s\n", gamemode_error_string() );
+	}
 
 	/* run game... */
 
-	gamemode_request_end(); // Not required, gamemoded will clean up after game exists anyway
+	gamemode_request_end(); // Not required, gamemoded can clean up after game exits
 ```
 
-### Using automatically
-
-#### Option 1: Include in code
+#### Implicit requests
+Simply use the header, but with `GAMEMODE_AUTO` defined.
 ```C
 #define GAMEMODE_AUTO
 #include "gamemode_client.h"
 ```
 
-#### Option 2: Link and distribute
-Add `-lgamemodeauto` to linker arguments and distribute `libgamemodeauto.so` with the game
+Or, distribute `libgamemodeauto.so` and either add `-lgamemodeauto` to your linker arguments, or add it to an LD\_PRELOAD in a launch script.
+
+---
+## Components
+
+### Host
+#### gamemoded
+Runs in the background, activates game mode on request, refcounts and also checks caller PID lifetime.
+
+Accepts `-d` (daemonize) and `-l` (log to syslog).
+
+#### libgamemode
+Internal library used to dispatch requests to the daemon.
+
+Note: `libgamemode` should never be linked with directly.
+
+### Client
+#### libgamemodeauto
+Simple dynamic library that automatically requests game mode when loaded.
+
+Useful to `LD_PRELOAD` into any game as needed.
 
-#### Option 3: Distribute and script
-Distribute `libgamemodeauto.so` with the game and add to LD\_PRELOAD in a launch script
+#### gamemode\_client.h
+Single header lib that lets a game request game mode and handle errors.
 
 ---
 ## Configuration
@@ -110,18 +92,31 @@ An example of what the file could look like is found in the `example` directory.
 
 The file parsing uses [inih](https://github.com/benhoyt/inih).
 
-
 ---
-## Pull Requests
-Pull requests must match with the coding style found in the `.clang-format` file
+## Contributions
+
+### Pull Requests
+Pull requests must match with the coding style found in the `.clang-format` file, please run this before commiting:
 ```
 clang-format -i $(find . -name '*.[ch]')
 ```
 
+### Planned Features
+* Additional mode-switch plugins
+* User configuration for local mode-switch plugins
+* Improved client state tracking (PID is unreliable)
+* API to query if game mode is active
+
+### Maintained by
+Marc Di Luzio (Feral Interactive)
+
+### Contributions by
+Ikey Doherty (Solus Project), Minze Zwerver (Ysblokje)
+
 ---
-## Planned Features
+## License
+
+Copyright © 2018 Feral Interactive
+
+GameMode is available under the terms of the BSD 3-Clause License (Revised)
 
-* Additional mode-switch plugins
-* User confuguration with whitelist/blacklist for programs
-* User configuration for custom mode-switch plugins
-* Additional state tracking not based solely on PID

data/gamemoded.1

@@ -1,6 +1,6 @@
 .\" Manpage for gamemoded.
 .\" Contact linux-contact@feralinteractive.com to correct errors or typos.
-.TH gamemoded 1 "6 March 2018" "0.3" "gamemoded man page"
+.TH gamemoded 1 "6 March 2018" "1.0" "gamemoded man page"
 .SH NAME
 gamemoded \- optimises system performance on demand
 .SH SYNOPSIS

example/archlinux/gamemode-git/PKGBUILD

@@ -1,7 +1,7 @@
 # Maintainer: Ysblokje <ysblokje at gmail dot com>
 pkgname=('gamemode-git')
-pkgver=0
-pkgrel=1    
+pkgver=1.0
+pkgrel=1
 pkgdesc="GameMode is a daemon/lib combo for Linux that allows games to request a set of optimisations be temporarily applied to the host OS."
 arch=('x86_64')
 url="https://github.com/FeralInteractive/gamemode.git"

meson.build

@@ -2,7 +2,7 @@ project(
     'gamemode',
     'c',
     default_options : ['c_std=c11'],
-    version: '0.3',
+    version: '1.0',
     license: 'BSD',
 )