diff --git a/README.md b/README.md index 6ca1f27..56e93b5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ -# YData's open-source-template +# "Awesome" development environment -New YData Open Source repositories should use this repository as a template. +Or just a development environment, it doesn't needs to be awesome. + + +Unfortunately this requires some knowledge about how to use a command line. + + +## Setting up your machine + +So, i will focus on the "dirty" mode (as some people refer), which means install everything in your machine, at least for now. + + +### macOS + +There is a better way, actually an awesome way of managing any kind of applications, it's called [homebrew](https://brew.sh/). + +⚠️ If you already have this installed, please skip this part ⚠️ + +So, first you need to install command line tools, a set of binaries and libraries required for development, just run: + +```bash +xcode-select --install +``` + +This will trigger the installation process and a few prompts will guide you through the process. + +When that is finished, go back + +## How to setup your python environment 🐍 + +### Universal way + +Using conda