Browse Source

Minor doc changes

Panagiotis Christopoulos Charitos 4 years ago
parent
commit
36cfee2a3e
2 changed files with 16 additions and 4 deletions
  1. 14 2
      Docs/CodeStyle.md
  2. 2 2
      README.md

+ 14 - 2
Docs/CodeStyle.md

@@ -1,8 +1,20 @@
 This document describes the style of code in AnKi 3D Engine. The code is written primarily in C++ with some GLSL and python as well.
 
+Table of contents
+=================
+
+* [Comments in C++ & GLSL](#Comments%20in%20C++%20&%20GLSL)
+* [Comments in python](#Comments%20in%20python)
+* [Naming conventions in C++ & GLSL](#Naming%20conventions%20in%20C++%20&%20GLSL)
+* [Naming conventions in python](#Naming%20conventions%20in%20python)
+* [Naming conventions for files and directories](#Naming%20conventions%20for%20files%20and%20directories)
+* [C++ rules](#C++%20rules)
+* [GLSL rules](#GLSL%20rules)
+* [Code formatting in C++ & GLSL](#Code%20formatting%20in%20C++%20&%20GLSL)
+* [Code formatting in python](#Code%20formatting%20in%20python)
 
 Comments in C++ & GLSL
-=====================
+======================
 
 All comments are C++ like:
 
@@ -247,7 +259,7 @@ Code formatting in C++ & GLSL
 clang-format deals with code formatting. To format all the C++ and GLSL files in the source tree type the following in a terminal:
 
 	$ cd /path/to/anki
-	$ ./tools/format_source.sh
+	$ ./Tools/FormatSource.sh
 
 If you need to format on Windows do the same from a WSL terminal.
 

+ 2 - 2
README.md

@@ -86,7 +86,7 @@ Alternatively, recent Visual Studio versions support building CMake projects fro
 This code repository contains **4 sample projects** that are built by default (`ANKI_BUILD_SAMPLES` CMake option):
 
 - `Sponza`: The Crytek's Sponza scene
-- `SimpleScene`: A simple scene
+- `SimpleScene`: A simple scene (Cornell box)
 - `PhysicsPlayground`: A scene with programmer's art and some physics interactions
 - `SkeletalAnimation`: A simple scene with an animated skin
 
@@ -103,5 +103,5 @@ prints some information, including possible errors.
 4 Contributing
 ==============
 
-There are no special rules if you want to contribute. Just create a PR. Read the code [style guide](Docs/CodeStyle.md)
+There are no special rules if you want to contribute. Just create a PR. Read the [code style guide](Docs/CodeStyle.md)
 before that though.