Daniele Bonini (皮夕): WebDev and DevOps by lots of Sim.pli.city bits 3 лет назад
Родитель
Сommit
4e8a43fbd9
1 измененных файлов с 24 добавлено и 0 удалено
  1. 24 0
      README.md

+ 24 - 0
README.md

@@ -1,2 +1,26 @@
 # MacSwap
 Swapping everything but burgers. On premise solution - GPL License
+
+Hello and welcome to MacSwap!<br><br>
+	   
+MacSwap is a light, simple, "peer-to-peer" software on premise for swapping your own stuff with others.<br><br>
+	   
+MacSwap is released under GPLv3 license, it is supplied AS-IS and we do not take any responsibility for its misusage.<br><br>
+	   
+MacSwap got built behind some cool features like the cube interface, object drag-n-drop between browser windows, full object serialization and xml.<br><br>
+         
+First step, use the left side panel password and salt fields to create the hash to insert in the config file. Remember to manually set there also the salt value.<br><br>
+	   
+As you are going to run MacSwap in the PHP process context, using a limited web server or phpfpm user, you must follow some simple directives for an optimal first setup:<br>
+<ol>
+  <li>Check the write permissions of your "data" folder in your web app private path; and set its path in the config file.</li>
+  <li>Set the default Business Type, City and Country of the stuff your are going to swap.</li>
+  <li>Set the MAX_BURGERS value stating the max number of burger the pp is going to manage.</li>
+  <li>Set the Editor Password of your burgers. This will be important to confirm your burger upload by dropping it and saving it.</li>
+	<li>In Public/js/cube-code.js, in mystart class method, check if you are using 'http' or 'https'.</li>	   
+</ol>
+	   
+<br>	
+     
+Hope you can enjoy it and let us know about any feedback: <a href="mailto:info@macswap.org" style="color:#e6d236;">info@macswap.org</a>
+