README (Mac OS X instructions)

README

@@ -1,36 +1,47 @@
-ip2e - Receive your public IP (dynamic) by email when it is renewed
+ip2e - Receive your public IP (dynamic) by email when it is renewed
-===================================================================
+===================================================================
-
+
-TOOLS
+TOOLS
------
+-----
-
+
-* ip2e-daemon.py: Daemon to control & send by email your public IP.
+* ip2e-daemon.py: Daemon to control & send by email your public IP.
-* ip2e-log.py: Tool to see the log file when daemon is running.
+* ip2e-log.py: Tool to see the log file when daemon is running.
-* ip2e-config.py: Tool to create a valid configuration file.
+* ip2e-config.py: Tool to create a valid configuration file.
-
+
-HOW TO INSTALL
+HOW TO INSTALL
---------------
+--------------
-
+
- * Unix systems (GNU/Linux,*BSD, Mac OS X, etc..)
+ * Unix systems (GNU/Linux,*BSD, etc..)
- ================================================
+ ======================================
-
+
-   - Open the terminal and type the following comands:
+   - Open the terminal and type the following comands:
-   
+   
-     $ git clone https://github.com/clamsawd/ip2e.git
+     $ git clone https://github.com/clamsawd/ip2e.git
-     $ cd ip2e
+     $ cd ip2e
-     # make
+     # make
-     
+     
-   Note: You must install git & python3 previously.
+   Note: You must install git & python3 previously.
-     
+   
- * Windows
+ * Mac OS X
- =========
+ ==========
- 
+ 
-   - Install Python 3.x from https://www.python.org/.
+    - Open the terminal and type the following comands:
-   - Download https://github.com/clamsawd/ip2e/archive/master.zip
+   
-   - Unzip the package in your system. For example in C:\Program Files\.
+     $ git clone https://github.com/clamsawd/ip2e.git
-   - Add the folder to PATH variable.
+     $ cd ip2e
-
+     # make -f makefile.osx
-HOW TO USE
+     
------------
+   Note: You must install git & python3 previously.
-
+     
-   - Read 'How-to-Use.txt".
+ * Windows
+ =========
+ 
+   - Install Python 3.x from https://www.python.org/.
+   - Download https://github.com/clamsawd/ip2e/archive/master.zip
+   - Unzip the package in your system. For example in C:\Program Files\.
+   - Add the folder to PATH variable.
+
+HOW TO USE
+-----------
+
+   - Read 'How-to-Use.txt".