diff --git a/01.-Setup-Development-Environment.md b/01.-Setup-Development-Environment.md new file mode 100644 index 0000000..617f556 --- /dev/null +++ b/01.-Setup-Development-Environment.md @@ -0,0 +1,31 @@ +## Prerequisites + +**Python 3** + +- Get Python version 3.4 or newer [here](https://www.python.org/downloads/) +- Also, install python developer packages via `sudo apt-get install python3-dev` + +**Add Repo** +- Add new source list to your computer from [this](https://github.com/Pardus-Kurumsal/lider-ahenk-installer/blob/master/ahenk-installer/conf/liderahenk.list) file. + +**Some Dev Libs** +- `sudo apt-get install python3-dev libffi-dev libssl-dev` + +**Slixmpp** +- Install slixmpp via `sudo apt-get install slixmpp` + +**Paramiko** +- Install slixmpp via `sudo apt-get install python3-paramiko` + +**Psutil** +- Install slixmpp via `sudo apt-get install python3-psutil` (ver 4.2.*) + +**CpuInfo** +- Install slixmpp via `sudo apt-get install python3-cpuinfo` + +## Setup + +1. Clone Ahenk project by running `https://github.com/Pardus-Kurumsal/ahenk.git` +2. Navigate to `etc/ahenk/ahenk.conf` file under the project directory and modify _pluginfolderpath_ & _receivefileparam_ properties if necessary. +3. Create a soft link for configuration directory by typing `sudo ln -s your/project/directory/ahenk/etc/ahenk/ /etc/ahenk` +4. If you are developing a plugin, you also need to point its path so that ahenk core can run it. To do this, you either have to modify **pluginFolderPath** property in _/etc/ahenk/ahenk.conf_ OR create another soft link for the plugin via `sudo mkdir -p /opt/ahenk && sudo ln -s /your/project/directory/ahenk-project-name/opt/ahenk/plugins/ /opt/ahenk/plugins` \ No newline at end of file