Subversion Repositories freemyipod

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
771 user890104 1
                  ____ ___  ____  _____ _____ ____  
2
   ___ _ __ ___  / ___/ _ \|  _ \| ____|  ___/ ___| 
3
  / _ \ '_ ` _ \| |  | | | | |_) |  _| | |_  \___ \ 
4
 |  __/ | | | | | |___ |_| |  _ <| |___|  _|  ___) |
5
  \___|_| |_| |_|\____\___/|_| \_\_____|_|   |____/ 
6
 
7
emCOREFS is a FUSE-based filesystem that uses emCORE's Monitor API
8
to provide communication with device's FS. It is still in very early
9
state, but some features (directory listing, reading files) are done.
10
 
11
For communication with the device, this application uses libusb 1.0.
12
 
13
Building
14
--------
15
You need:
16
1. GCC/Make
17
2. pkg-config
18
3. libusb >= 1.0
19
4. libfuse >= 2.8
20
5. maybe other packages
21
 
22
Compiling:
23
make - standard build, no debug messages, only fatal errors on
24
    startup are shown.
25
make debug - debug build, some debug/error messages are shown.
26
    libusb debug messages are enabled, too.
27
 
28
Testing:
29
make test - run the build without FUSE debugging messages, going
30
    into the background if it connects to the device successfully.
31
make testdebug - run the build in the foreground, showing FUSE debug
32
    messages in the terminal.
33
 
34
Running
35
-------
36
You need FUSE >= 2.8 installed.
37
Currently only tested on Linux (Ubuntu 11.04 in my case). Maybe an
38
OSX-compatible version would appear at some point.
39
Starting: ./emcorefs <mountpoint>
40
Stopping: fusermount -u <mountpoint as seen in /etc/mtab>
41
 
42
Known bugs/issues
43
-----------------
784 user890104 44
* Write support not tested very well.
771 user890104 45
* Running FUSE with multithreading breaks file reading because of
46
    the way these are implemented on emCORE's side.
47
    Workaround: use the "-s" option.
48
* Most errors are not handled properly, EIO (Input/output error) is
49
    given in many cases where there's a more descriptive error
50
    message available. Will be fixed in the future.
51
 
52
Future plans
53
------------
54
* Merge some functions that are doing similar tasks to reduce code
55
    duplication. Return proper error codes in FS operations.
56
 
57
Bug reporting
58
-------------
59
Main developer: Vencislav "user890104" Atanasov
60
How to contact: http://www.freemyipod.org/wiki/Contact
61
 
62
License terms
63
-------------
64
emCOREFS is distributed under the same license terms as emCORE.
65
 
66
emCORE is free software: you can redistribute it and/or
67
modify it under the terms of the GNU General Public License as
68
published by the Free Software Foundation, either version 2 of the
69
License, or (at your option) any later version.
70
 
71
emCORE is distributed in the hope that it will be useful,
72
but WITHOUT ANY WARRANTY; without even the implied warranty of
73
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
74
See the GNU General Public License for more details.
75
 
76
You should have received a copy of the GNU General Public License
77
along with emCORE.  If not, see <http://www.gnu.org/licenses/>.