Skip to content

Commit bd6761c

Browse files
authored
refactor readme
1 parent 190611e commit bd6761c

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@ Gitless
22
=======
33

44
[![PyPI version](https://badge.fury.io/py/gitless.svg)](
5-
http://badge.fury.io/py/gitless)
6-
[![homebrew](https://img.shields.io/homebrew/v/gitless.svg)](http://braumeister.org/formula/gitless)
7-
[![Build Status](https://travis-ci.org/sdg-mit/gitless.svg?branch=master)](https://travis-ci.org/sdg-mit/gitless)
5+
http://badge.fury.io/py/gitless "PyPI version")
6+
[![Homebrew Formula](https://img.shields.io/homebrew/v/gitless.svg)](http://braumeister.org/formula/gitless "Homebrew Formula")
7+
[![Travis Build Status](https://travis-ci.org/sdg-mit/gitless.svg?branch=master)](https://travis-ci.org/sdg-mit/gitless "Travis Build Status")
8+
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/sdg-mit/gitless?svg=true)](https://ci.appveyor.com/project/spderosso/gitless "AppVeyor Build Status")
89

910
[Gitless](http://gitless.com "Gitless's website") is an experimental version
1011
control system built on top of Git. Many
@@ -27,10 +28,10 @@ We currently require Git (1.7.12+) to be installed (but this requirement is
2728
going to disappear soon once we finish with our migration to pygit2).
2829

2930

30-
### Binary releases
31+
### Binary releases (macOS and Linux only)
3132

32-
Binary releases for Mac OS and Linux are available from the
33-
[Gitless's website](http://gitless.com "Gitless's website").
33+
Binary releases for macOS and Linux are available from the
34+
[Gitless website](http://gitless.com "Gitless's website").
3435

3536
If you've downloaded a binary release of Gitless everything is contained in the
3637
gl binary, so to install simply do:
@@ -41,15 +42,18 @@ You can put the binary in other locations as well, just be sure to update your
4142
`PATH`.
4243

4344
If for some reason this doesn't work (maybe you are running an old version of
44-
your OS?), try one of the other options (installing from source code or via
45+
your OS?), try one of the other options (installing from source or via
4546
the Python Package Index).
4647

4748

4849
### Installing from source
4950

50-
To install from source you need to have Python (2.7, 3.2+ or pypy)
51+
To install from source you need to have Python (2.7, 3.2+ or PyPy)
5152
installed.
5253

54+
Note to Windows users: Python 3 is not supported yet,
55+
see [#146](https://github.com/sdg-mit/gitless/issues/146) for more info.
56+
5357
Additionally, you need to [install pygit2](
5458
http://www.pygit2.org/install.html "pygit2 install").
5559

@@ -63,7 +67,10 @@ and do:
6367

6468
If you are a Python fan you might find it easier to install
6569
Gitless via the Python Package Index. To do this, you need to have
66-
Python (2.7, 3.2+ or pypy) installed.
70+
Python (2.7, 3.2+ or PyPy) installed.
71+
72+
Note to Windows users: Python 3 is not supported yet,
73+
see [#146](https://github.com/sdg-mit/gitless/issues/146) for more info.
6774

6875
Additionally, you need to [install pygit2](
6976
http://www.pygit2.org/install.html "pygit2 install").
@@ -72,22 +79,16 @@ Then, just do:
7279

7380
$ pip install gitless
7481

75-
### Installing via Homebrew
82+
### Installing via Homebrew (macOS only)
7683

7784
If you are using [Homebrew](http://brew.sh/ "Homebrew homepage"), a package
78-
manager for Mac OS, then you can simply install Gitless with:
85+
manager for macOS, you can install Gitless with:
7986

8087
```
8188
brew update
8289
brew install gitless
8390
```
8491

85-
### Windows Compatibility
86-
87-
For now, Windows support is unavailable for Python3+ due to pbs dependency
88-
(which is not Python3 compatible). See
89-
[#146](https://github.com/sdg-mit/gitless/issues/146) for more info.
90-
9192
Documentation
9293
-------------
9394

0 commit comments

Comments
 (0)