updating readme (#54)

README.md

@@ -1 +1,24 @@
 ## Orb Community Website
+
+Orb documentation can be accessed [here](https://orb.community/).
+
+This documentation is made in mkdocs, so for local development follow the steps below:
+
+> ⚠️ Some mkdocs features do not render properly in pure markdown. Please, use the local server locally.
+
+## Setup your Python environment
+
+<b>You need to have python >= 3.8 installed</b>
+
+Create a virtual environment: `$ python3 -m venv name_of_virtualenv`
+
+Activate your virtual environment: `$ source name_of_virtualenv/bin/activate`
+
+Install the required libraries: `$ pip install -r requirements.txt`
+
+
+## Start the server
+
+`$ mkdocs serve`
+
+For more information access [mkdocs documentation](https://www.mkdocs.org/) and [material theme documentation](https://squidfunk.github.io/mkdocs-material/).

requirements.txt

@@ -0,0 +1,2 @@
+mkdocs==1.5.3
+mkdocs-material==9.4.8