You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**To be Noted:** The `master` branch contains the latest stable build of the project. For a reliable experience, always clone the repo from the master branch.
27
+
**To be Noted:** The `master` branch contains the latest and the stable build of the project. For a reliable experience, always clone the repo from the master branch.
28
28
29
29
```shell
30
30
@@ -46,13 +46,13 @@ make build
46
46
47
47
```
48
48
49
-
-**Option - 2** If you are into **docker**, then there is also a docker image available for gitconvex
49
+
-**Option - 2** If you are into **docker**, then there is a docker image available for gitconvex
50
50
51
51
```shell
52
52
docker pull itassistors/gitconvex
53
53
```
54
54
55
-
**Note:** Make sure you mount the host volume to the container to access the git repos from the host system. If you have git repos stored within your containers, then this is not required
55
+
**Note:** Make sure you mount the host volume to the container, to access the git repos from the host system. If you have git repos stored within your containers, then this is not required
56
56
57
57
-**Option - 3** Downloading the zip file from the tagged github [**release**](https://github.com/neel1996/gitconvex/releases)
58
58
@@ -80,9 +80,9 @@ make build
80
80
81
81
| Software | Purpose |
82
82
| --- | --- |
83
-
| <b>[Git](https://git-scm.com/)</b> | <b>Required for handling some intense git operations with the target repo</b> |
83
+
| <b>[Git](https://git-scm.com/)</b> | <b>Required for handling some git operations with the target repo</b> |
84
84
| <b>[Go](https://golang.org/)</b> | <b>For building the backend from the source</b> |
85
-
| <b>[Node JS](https://nodejs.org/en/)</b> | <b>For building the react UI bundle from scratch</b> |
85
+
| <b>[Node JS](https://nodejs.org/en/)</b> | <b>For building the React UI bundle from scratch</b> |
86
86
87
87
> **Important note for windows users**
88
88
@@ -105,37 +105,24 @@ C:\> git --version
105
105
operable program or batch file.
106
106
```
107
107
108
-
This can be fixed by adding `git` to the PATH environment variable in windows. The process of setting this up is available [here](https://stackoverflow.com/questions/26620312/git-installing-git-in-path-with-github-client-for-windows#answer-53706956:~:text=comment-,27,Here%20is%20the%20magic)
108
+
This can be fixed by adding `git` to the PATH environment variable in windows. The steps for setting this up is available [here](https://stackoverflow.com/questions/26620312/git-installing-git-in-path-with-github-client-for-windows#answer-53706956:~:text=comment-,27,Here%20is%20the%20magic)
109
109
110
110
> **🍎 Important note for MacOS users**
111
111
112
-
The pre-built bundle for MacOS is not a verfieid or signed bundle. So gatekeeper could warn you or even prevent you from using gitconvex on your Mac devices. If this is the case then I recommend building the application from scratch using the `Makefile` included in the repo. Follow **[Option - 1](#download-options)** mentioned above to build the application from scratch.
112
+
The pre-built bundle for MacOS is not a verified or signed bundle, so gatekeeper could warn you or even prevent you from using gitconvex on your Mac devices. If this is the case, then I recommend building the application from scratch using the `Makefile` included in the repo. Follow **[Option - 1](#download-options)** mentioned above to build the application from scratch.
113
113
114
-
**Reason** - Enrolling in the apple developer program for making the application a verfied one will cost me 100 USD anually. So I will do it once the project gets enough reach
114
+
**Reason** - Enrolling in the apple developer program for making the application a verified one will cost me 100 USD annually, so I will do it once the project gets enough reach
115
115
116
116
# Detailed documentation
117
117
118
118
Refer the detailed [Documentation](DOCUMENTATION.md) for how to setup and use the platform
119
119
120
120
121
121
# Contributions
122
-
123
-
This is the final production build for **gitconvex** and direct contributions will not be accepted to this repo. If you wish to contribute to this project, then it has to be made to the following repos which are dedicated to the frontend (React) and backend (Go) for the platform
0 commit comments