File tree 1 file changed +31
-1
lines changed
1 file changed +31
-1
lines changed Original file line number Diff line number Diff line change @@ -99,7 +99,37 @@ The CLI uses various crates, please see _'Development Status'_ for details.
99
99
100
100
## Installation
101
101
102
- ** TBD**
102
+ ### Binary Release
103
+
104
+ ``` sh
105
+ curl -LSfs https://raw.githubusercontent.com/byron/git-oxide/master/ci/install.sh | \
106
+ sh -s -- --git byron/git-oxide --crate gio-max-termion
107
+ ```
108
+
109
+ See the [ releases section] [ releases ] for manual installation and various alternative builds that are _ slimmer_ or _ smaller_ , depending
110
+ on your needs, for _ Linux_ , _ MacOS_ and _ Windows_ .
111
+
112
+ [ releases ] : https://github.com/Byron/git-oxide/releases
113
+
114
+ #### Cargo
115
+
116
+ ` cargo ` is the Rust package manager which can easily be obtained through [ rustup] [ rustup ] . With it, you can build your own binary
117
+ effortlessly and for your particular CPU for additional performance gains.
118
+
119
+ ```
120
+ # The default installation, 'max'
121
+ cargo install gitoxide
122
+
123
+ # On linux, it's a little faster to compile the termion version, which also results in slightly smaller binaries
124
+ cargo install gitoxide --no-default-features --features max-termion
125
+
126
+ # For smaller binaries and even faster build times that are traded for a less fancy CLI implementation, use `lean`
127
+ # or `lean-termion` respectively.
128
+ cargo install gitoxide --no-default-features --features lean
129
+ ```
130
+
131
+ [ releases] : https://github.com/Byron/git-oxide/releases
132
+ [ rustup ] : https://rustup.rs
103
133
104
134
## Project Goals
105
135
You can’t perform that action at this time.
0 commit comments