Meta: add to README
[steamworks] / README
1 This repository holds notes and code for the initial implementation
2 of parts of the SteamWorks system, in particular the Crank, Shaft and
3 Pulley parts of that system.
4
5     docs/                Holds project documentation
6     src/                 Project sources
7     src/3rdparty         3rd-party imported sources
8     src/common           Support code, common components
9     src/crank            Steamworks Crank component
10
11 See LICENSE for overall licensing information, and a README in each
12 subdirectory for local details. See README.<os> for details regarding
13 SteamWorks on a particular operating system and for build dependencies.
14 For a quick start (assuming the build dependencies are met; otherwise
15 you will get error messages that point out what is missing), just run
16
17     make
18
19 to create a build directory, configure and build the system. For example
20 usage of the system, see the examples/ directories in the various
21 components directories.
22