Skip to content

Commit fcb687b

Browse files
neel1996neel1996
authored
update README for v2.1.0 readiness
1 parent 70b511f commit fcb687b

File tree

1 file changed

+46
-59
lines changed

1 file changed

+46
-59
lines changed

‎README.md‎

Lines changed: 46 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44

55
<p align="center">
66
<img src="https://user-images.githubusercontent.com/47709856/87170859-8bfff080-c2ef-11ea-9140-b9e5db1c17d8.png" width="280">
7-
<p align="center">
8-
<a href="https://www.producthunt.com/posts/gitconvex-2?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-gitconvex-2" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=241240&theme=dark" alt="gitconvex - A web based UI client for managing git repositories | Product Hunt Embed" style="width: 250px; height: 54px;" width="250px" height="54px" /></a>
9-
</p>
107
</p>
118

129
## Build Status
@@ -18,48 +15,62 @@
1815

1916
> Use any of the below options to get gitconvex for your system
2017
21-
[![github release](https://img.shields.io/static/v1?label=gitconvex&message=v2.0.1&color=green&style=for-the-badge&logo=github)](https://github.com/neel1996/gitconvex-package/releases)
22-
[![docker image](https://img.shields.io/static/v1?label=gitconvex&message=v2.0.1&color=blue&style=for-the-badge&logo=docker)](https://hub.docker.com/repository/docker/itassistors/gitconvex)
18+
[![github release](https://img.shields.io/static/v1?label=gitconvex&message=v2.1.0&color=green&style=for-the-badge&logo=github)](https://github.com/neel1996/gitconvex-package/releases)
19+
[![gitconvex-choco](https://img.shields.io/chocolatey/v/gitconvex?logo=C&style=for-the-badge)](https://chocolatey.org/packages/gitconvex)
20+
[![docker image](https://img.shields.io/static/v1?label=gitconvex&message=v2.1.0&color=blue&style=for-the-badge&logo=docker)](https://hub.docker.com/repository/docker/itassistors/gitconvex)
2321

22+
- [Windows](#windows)
23+
- [Linux](#linux)
24+
- [MacOS](#macos)
25+
- [Docker](#docker)
2426

25-
- **Option - 1** Cloning the repo from **github**
27+
## Windows
2628

27-
To build gitconvex from scratch, [libgit2](https://github.com/libgit2/libgit2) is required. The [LIBGIT_NOTES](LIBGIT_NOTES.md) includes the guidelines to download and setup libgit for different platforms
29+
Gitconvex is available on [chocolatey](https://chocolatey.org/). Install [chocolatey](https://chocolatey.org/install) and run the following command to install gitconvex
2830

29-
**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.
31+
```shell
32+
> choco install gitconvex
33+
```
3034

31-
``` shell
35+
If you do not prefer `chocolatey` then the [binaries for windows](https://github.com/neel1996/gitconvex/releases/download/2.1.0/gitconvex-2.1.0.zip) can be downloaded from the [releases](https://github.com/neel1996/gitconvex/releases/tag/2.1.0)
3236

33-
git clone https://github.com/neel1996/gitconvex.git
34-
cd gitconvex
37+
## Linux
3538

36-
# for Mac & Linux
37-
make build
39+
Download the tarball for Linux from [releases](https://github.com/neel1996/gitconvex/releases/tag/2.1.0). Extract the tar and run the following script to install the required dependencies
3840

39-
# for Windows
40-
./make.bat build
41+
``` shell
42+
> ./lib/linux_x86_64/install_deps
43+
```
4144

42-
## After build completion...
43-
./dist/gitconvex-server
45+
After setting up the dependency libs, just run `gitconvex` from the terminal to start gitconvex
4446

45-
2020/11/14 22:57:47 INFO: Starting Gitconvex server modules
46-
2020/11/14 22:57:47 INFO: Using available env config file
47-
2020/11/14 22:57:47 INFO: Gitconvex started on http://localhost:9001
47+
## MacOS
4848

49+
Gitconvex is readily available as a [Homebrew](https://brew.sh/) Tap on github. Run the following command to download & install gitconvex on the go
50+
51+
``` shell
52+
> brew install itassistors/brew/gitconvex
4953
```
5054

51-
- **Option - 2** If you are into **docker**, then there is a docker image available for gitconvex
55+
## Docker
56+
57+
If you are into **docker**, then there is a docker image available for gitconvex
5258

5359
``` shell
5460
docker pull itassistors/gitconvex
5561
```
5662

57-
**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
63+
**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 it is not required
5864

59-
- **Option - 3** Downloading the zip file from the tagged github [**release**](https://github.com/neel1996/gitconvex/releases)
65+
## Build from scratch
66+
67+
To build gitconvex from scratch, [libgit2](https://github.com/libgit2/libgit2) is a requirement. The [LIBGIT_NOTES](LIBGIT_NOTES.md) file includes all the guidelines to download and setup libgit for different platforms
68+
69+
**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.
6070

6171
``` shell
62-
## Extract the downloaded zip file and execute the commands
72+
73+
git clone https://github.com/neel1996/gitconvex.git
6374
cd gitconvex
6475

6576
# for Mac & Linux
@@ -68,6 +79,13 @@ make build
6879
# for Windows
6980
./make.bat build
7081

82+
# After build completion...
83+
./dist/gitconvex-server
84+
85+
2020/11/14 22:57:47 INFO: Starting Gitconvex server modules
86+
2020/11/14 22:57:47 INFO: Using available env config file
87+
2020/11/14 22:57:47 INFO: Gitconvex started on http://localhost:9001
88+
7189
```
7290

7391
# Platforms
@@ -82,51 +100,22 @@ make build
82100

83101
| Software | Purpose |
84102
| --- | --- |
85-
| <b>[Git](https://git-scm.com/)</b> | <b>Required for handling some git operations with the target repo</b> |
103+
| <b>[Git](https://git-scm.com/)</b> | <b>For cloning gitconvex and to build the application from scratch</b> |
86104
| <b>[Go](https://golang.org/)</b> | <b>For building the backend from the source</b> |
87105
| <b>[Node JS](https://nodejs.org/en/)</b> | <b>For building the React UI bundle from scratch</b> |
88106

89-
> **Important note for windows users**
90-
91-
If you are a windows user, then make sure that `git` is accessible from the command line without using git bash.
92-
93-
- Open command prompt or powershell and enter `git --version` and press enter. If it displays the following output, then it is fine
94-
95-
``` cmd
96-
C:\> git --version
97-
98-
git version 2.28.0.windows.1
99-
```
100-
101-
If this output is not displayed and if the command throws the following error, then it shows that `git` is not added to the 'path' environment variable and it will not be accessible directly from the command line,
102-
103-
``` cmd
104-
C:\> git --version
105-
106-
'git' is not recognized as an internal or external command,
107-
operable program or batch file.
108-
```
109-
110-
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)
111-
112-
> **🍎 Important note for MacOS users**
113-
114-
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.
115-
116-
**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
117-
118107
# Detailed documentation
119108

120109
Refer the detailed [Documentation](DOCUMENTATION.md) for how to setup and use the platform
121110

122-
123111
# Contributions
124-
Contributions are always welcome for the project. Please do refer the [Contribution Guidelines]( CONTRIBUTING.md) for details
112+
Contributions are always welcome for the project. Please do refer the [Contribution Guidelines](CONTRIBUTING.md) for details
113+
125114
# Help and Feedback
126115

127116
For reporting issues or for requesting a new feature, use the following channels
128117

129-
[**Discord Channel** ](https://discord.gg/PSd2Cq9)
118+
[**Discord Channel**](https://discord.gg/PSd2Cq9)
130119

131120
[**Website**](https://gitconvex.com/)
132121

@@ -137,5 +126,3 @@ For reporting issues or for requesting a new feature, use the following channels
137126
# License
138127

139128
[![License](https://img.shields.io/static/v1?label=LICENSE&message=Apache-2.0&color=yellow&style=for-the-badge)](LICENSE)
140-
141-

0 commit comments

Comments
 (0)