Browse Source

Updated README

Julien 'Lta' BALLET 11 years ago
parent
commit
7cc19f0974
1 changed files with 38 additions and 18 deletions
  1. 38 18
      README.md

+ 38 - 18
README.md

@@ -1,26 +1,46 @@
-== liBDSM
+# liBDSM
 
-A small project of SMB protocol client implementation in C, with a lot less
-features than Samba but also a more permissive license (WTFL). Final final goal
-is to have an iOS VLC integration.
+A small project of SMB protocol client implementation in C, with a _lot_ less
+features than Samba but also a more permissive license (WTFL/MIT). The initial
+goal of this project is to have a lib with an iOS compatible license to be
+intgrated into VLC for iOS.
 
-=== How to build
+The lib is provided as a static library or as a dynamically linked library. A
+few useless (yet) utils are also provided.
 
-At this stage of the project, you're kind of a masochist... Hey ! you're just at
-the right place for this. Simply type 'make', correct Makefile if necessary and
-fix any error you have. (Hum... Enjoy!)
+## Building
 
-=== Goals
+### Requirements
+
+* A Unix system with a bash-shell (i guess)
+* C99 C compiler
+* (GNU) Make
+* Autotools
+* libc with iconv
+* getopt_long
+
+Most of it can be installed on Debian(-based) systems using
+
+    sudo apt-get install build-essential
+
+### HowTo
+
+    $> ./bootstrap
+    $> ./configure --prefix=/your/ass
+    $> make
+    $> make install # maybe
+
+## Goals
 
 Here's a list of features i intend to support in this project :
 * NETBIOS
-  ** Basic bi-directionnal NETBIOS name resolution [Done]
-  ** Hacky LAN SMB servers discovery (Listing all the smb servers on the LAN, no WINS, etc.) [Done]
-  ** Basic NETBIOS Session transport layer [Done]
+  * Basic bi-directionnal NETBIOS name resolution [Done]
+  * Hacky LAN SMB servers discovery (Listing all the smb servers on the LAN, no WINS, etc.) [Done]
+  * Basic NETBIOS Session transport layer [Done]
 * SMB
-  ** Support only required parts of 'NT LM 0.12' (aka CIFS?) dialect.
-  ** User based authentication [Done]
-  ** List Shares [Partial/Ugly]
-  ** Browse folders
-  ** Read file [Done, can be improved :)]
-  ** No write, lock, RPCs, etc.
+  * Support only required parts of 'NT LM 0.12' (aka CIFS?) dialect.
+  * User based authentication [Done]
+  * List Shares [Partial/Ugly]
+  * Browse folders [Done/Ugly]
+  * Read file [Done, can be improved :)]
+  * No write, lock, RPCs, etc. [Hum]