Skip to content

Commit da49ce1

Browse files
authored
Update README.md
1 parent 012e34d commit da49ce1

File tree

1 file changed

+37
-3
lines changed

1 file changed

+37
-3
lines changed

Diff for: README.md

+37-3
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ bread remove user/repo
6262

6363
---
6464

65-
### Full usage
65+
## Full usage
6666

6767
```bash
6868
Usage: bread <command>
@@ -88,11 +88,45 @@ Run "bread <command> --help" for more information on a command.
8888

8989
---
9090

91-
### Todo
91+
## Building From Source
92+
93+
Make Sure You Have Go version 1.17.x & [AppImage Builder](https://appimage-builder.readthedocs.io/en/latest/) Installed.
94+
95+
Get The Repository Via Git:
96+
97+
```bash
98+
git clone https://github.com/DEVLOPRR/bread
99+
```
100+
101+
Go Inside The Source Code Directory & Get All The Dependencies:
102+
103+
```bash
104+
cd bread
105+
go mod tidy
106+
```
107+
108+
Make The Build Script Executable And Run It
109+
110+
```bash
111+
chmod +x ./make
112+
./make
113+
```
114+
115+
And To Build The AppImage Run
116+
117+
```bash
118+
./make appimage
119+
```
120+
121+
---
122+
123+
## Todo
92124
- Improve UI
93125
- Work On Reducing Binary Sizes
94126
- Add `-v, --version` To Get The Version
95127
- Mirrors:
96128
- I Would Like To Introduce Concept Of Mirror Lists Which Contain The List Of AppImages With The Download URL, tho currently i am not working on it but in future i might.
97129

98-
## Thanks
130+
---
131+
132+
# Thanks

0 commit comments

Comments
 (0)