@@ -3,17 +3,14 @@ gitfs [ file system that fully
8
7
integrates with git. You can mount a remote repository's branch locally, and any
9
8
subsequent changes made to the files will be automatically committed to the
10
9
remote.
11
10
12
- gitfs was developed by the awesome engineering team at [ Presslabs] ( https://www.presslabs.com/ ) ,
11
+ gitfs was developed by the awesome engineering team at [ Presslabs] ( https://www.presslabs.com/ ) ,
13
12
a Managed WordPress Hosting provider.
14
13
15
- For more open-source projects, check [ Presslabs Code] ( https://www.presslabs.org/ ) .
16
-
17
14
## What's its purpose?
18
15
19
16
gitfs was designed to bring the full powers of git to everyone, no matter how
@@ -26,6 +23,41 @@ gitfs is useful in places where you want to keep track of all your files, but at
26
23
the same time you don't have the possibility of organizing everything into
27
24
commits yourself. A FUSE filesystem for git repositories, with local cache.
28
25
26
+ ## Installing
27
+
28
+ We provide packages for the major Ubuntu releases and MacOS, but you can find community packages for most of popular Linux
29
+ distributions. If you want to build packages for a distribution, or you already did, please contact us and we'll list it here.
30
+
31
+ ### Ubuntu 18.04+
32
+
33
+ ``` bash
34
+ sudo add-apt-repository ppa:presslabs/gitfs
35
+ sudo apt-get update
36
+ sudo apt-get install gitfs
37
+ ```
38
+
39
+ ### MacOS
40
+ ``` bash
41
+ brew install gitfs
42
+ ```
43
+
44
+ ## Usage
45
+
46
+ You can mount a remote or local repository easly, just by providing the repository to clone and a directory used to mount.
47
+
48
+ ``` bash
49
+ gitfs http://your.com/repository.git /mount/directory
50
+ ```
51
+
52
+ The entire filesystem can be tweaked when mounting it, using a set of options.
53
+
54
+ ``` bash
55
+ gitfs git@github.com:user/repo.git /mypath -o
56
+ repo_path=/tmp/path,branch=dev,log=-,debug=true,foreground=true,fetch_timeout=0.1,merge_timeout=0.1...
57
+ ```
58
+
59
+ For an entire list of options, you can check the [ arguments page] ( https://www.presslabs.com/code/gitfs/gitfs-arguments/ ) .
60
+
29
61
## Features
30
62
* Automatically commits changes: create, delete, update files and their metadata
31
63
* Browse through working index and commit history
0 commit comments