Skip to content

Commit 3032b1e

Browse files
Updated document
1 parent 51830fc commit 3032b1e

File tree

1 file changed

+4
-18
lines changed

1 file changed

+4
-18
lines changed

DOCUMENTATION.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ The main goal of this platform is to act as a web-based alternative for Github d
44
## Table of Contents
55
[Requirements](#requirements)<br>
66
[Download Options](#download-options)<br>
7-
[Setup](#setup)<br>
87
[Features available](#features-available)<br>
98
[How to use](#how-to-use)
109
- [Adding a new repo](#adding-a-new-repo)
@@ -34,26 +33,13 @@ $ cd gitconvex
3433
3534
# for Mac & Linux
3635
$ make build
36+
$ ./dist/gitconvex
3737
3838
# for Windows
3939
$ ./make.bat build
40-
40+
$ ./dist/gitconvex.exe
4141
```
4242

43-
## Setup
44-
$ git clone https://github.com/neel1996/gitconvex.git
45-
<br>
46-
$ cd gitconvex
47-
48-
# For Mac & Linux
49-
$ make build
50-
51-
# For Windows
52-
$ ./make.bat build
53-
54-
## After build completion...
55-
$ ./dist/gitconvex-server
56-
5743
## Features available
5844
- Visualizing basic repo stats such as active branch, active remotes, number of files tracked etc
5945
- Tracking modified files
@@ -81,7 +67,7 @@ $ ./dist/gitconvex-server
8167
![add-a-repo](https://user-images.githubusercontent.com/65342122/88536126-db9d2680-d028-11ea-890f-c5fc11cd7cf0.png)
8268

8369
- Enter repo name and paste the repo path. If the folder is not a git repo then check the "*Check this if the folder is not a git repo*" checkbox to initialize git.
84-
![repo-details](https://user-images.githubusercontent.com/65342122/101984594-80eb2b00-3ca8-11eb-97e5-5804ddfaed61.png)
70+
![repo-details](https://user-images.githubusercontent.com/65342122/101985829-556c3e80-3cb0-11eb-8449-ed9a05621c8e.png)
8571

8672
- The newly added repo will be displayed as a card in the dashboard
8773
![repo-card](https://user-images.githubusercontent.com/65342122/89167157-ab113b80-d598-11ea-8985-2469e7ad261e.png)
@@ -175,4 +161,4 @@ In "Git Difference" click on the modified file to see the difference. The platfo
175161
## Help and Support
176162

177163
- Visit help section if you're facing an issue or need any help. If you have any queries or feedback, then discuss it in "Discord" or report an issue in GitHub.
178-
![help-and-support](https://user-images.githubusercontent.com/65342122/101984821-d96ef800-3ca9-11eb-913e-f1cc062fae56.png)
164+
![help-and-support](https://user-images.githubusercontent.com/65342122/101987492-5efaa400-3cba-11eb-87fb-6d8cb19ae9d2.png)

0 commit comments

Comments
 (0)