Link to the dev docs + move emojis

Make sure you can easily find the dev docs Signed-off-by: Tim Smith <[email protected]>
mondoohq · Oct 7, 2022 · f0149b9 · f0149b9
1 parent acc0db4
commit f0149b9
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -141,11 +141,7 @@ Our goal is to become the API for your entire infrastructure. Join our [communit
 
 ## Development
 
-We love emojis in our commits. These are their meanings:
-
-🛑 breaking 🐛 bugfix 🧹 cleanup/internals 📄 docs  
-✨⭐🌟🎉 smaller or larger features 🐎 race condition  
-🌙 MQL 🌈 visual 🍏 fix tests 🎫 auth 🦅 falcon 🐳 container  
+See our [Development Documentation](docs/development.md) for information on building and contributing to cnquery.
 
 ## Legal
 

diff --git a/docs/development.md b/docs/development.md
@@ -1,12 +1,14 @@
 # Development
 
-## Prerequisites
+## Building
+
+### Prerequisites
 
 Before building from source, be sure to install:
 
 - [Go 1.19.0+](https://golang.org/dl/)
 - [Protocol Buffers v21+](https://github.com/protocolbuffers/protobuf/releases)
-- 
+
 On macOS systems with Homebrew, run: `brew install [email protected] protobuf`
 
 ## Installation from source
@@ -34,7 +36,7 @@ If `go` is not installed or an older version exists, follow instructions on [the
     make cnquery/install
     ```
 
-## Develop cnquery, provider or resources
+### Develop cnquery, provider or resources
 
 Whenever you change resources, providers, or protos, you must generate files for the compiler. To do this, make sure you have the necessary tools installed (such as protobuf):
 
@@ -48,4 +50,14 @@ Then, whenever you make changes, just run:
 make cnquery/generate
 ```
 
-This generates and updates all required files for the build. At this point you can `make cnquery/install` again as outlined above.
+This generates and updates all required files for the build. At this point you can `make cnquery/install` again as outlined above.
+
+## Contributing
+
+### Marking PRs with Emojis
+
+We love emojis in our commits. These are their meanings:
+
+🛑 breaking 🐛 bugfix 🧹 cleanup/internals 📄 docs  
+✨⭐🌟🎉 smaller or larger features 🐎 race condition  
+🌙 MQL 🌈 visual 🍏 fix tests 🎫 auth 🦅 falcon 🐳 container