Move docs to separate folder

ocen-lang · Nov 7, 2024 · 8115269 · 8115269
1 parent 55fa905
commit 8115269
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -64,13 +64,16 @@ $ ocen file.oc -o ./build/out # generates ./build/out and ./build/out.c
 $ ocen file.oc -n -c ./temp.c # generates only ./temp.c
 ```
 
-For tips on developing the compiler, see [DEVELOPING.md](./DEVELOPING.md).
+## Usage
 
-## Language
+- For an overview of the language and it's features, look at the [getting started doc](./docs/GETTING_STARTED.md).
+- For tips / workflow on developing the compiler, look at the [compiler development doc](./docs/DEVELOPMENT.md).
+- For recommended code style (used in the repo), look at the [style guide](./docs/CODE_STYLE.md).
 
-You can find various examples of the language in:
-- [tests](./tests): Unit tests for the compiler
+
+You also can find various examples of the language being used in:
+- [tests](./tests): Unit tests for the compiler (shows all the features)
 - [std](./std): The standard library (implementations + C bindings)
-- [examples](./examples): Various examples of the language
+- [examples](./examples): Few non-trivial examples of programs
 - [compiler](./compiler): The compiler itself!
 
diff --git a/CODE_STYLE.md → docs/CODE_STYLE.md b/CODE_STYLE.md → docs/CODE_STYLE.md
diff --git a/DEVELOPING.md → docs/COMPILER_DEVELOPMENT.md b/DEVELOPING.md → docs/COMPILER_DEVELOPMENT.md
diff --git a/GETTING_STARTED.md → docs/GETTING_STARTED.md b/GETTING_STARTED.md → docs/GETTING_STARTED.md