README.md 4.03 KB
Newer Older
1
# Gnome Commander #
2

3
[![GitHub license](https://img.shields.io/badge/license-GPLv2-blue.svg)](https://raw.githubusercontent.com/GNOME/gnome-commander/master/COPYING)  |  [![GitHub commits](https://img.shields.io/github/commits-since/gcmd/gnome-commander/1.10.3/gcmd-1-10)](https://gitlab.gnome.org/GNOME/gnome-commander/tree/master/)
4

5 6
## Introduction ##

7
Gnome Commander is a fast and powerful twin-panel file manager for the Linux desktop.
8

Uwe Scholz's avatar
Uwe Scholz committed
9 10
![ScreenShot](https://gcmd.github.io/ss/MainWin-Classic.png)

11
* Website: https://gcmd.github.io/
12
* Bugs: https://gitlab.gnome.org/GNOME/gnome-commander/issues
Uwe Scholz's avatar
Uwe Scholz committed
13

14
### Mailing lists ###
Uwe Scholz's avatar
Uwe Scholz committed
15 16 17 18

* https://lists.nongnu.org/mailman/listinfo/gcmd-users → for users
* https://lists.nongnu.org/mailman/listinfo/gcmd-devel → for developers

19
You can find email addresses of the people who have created Gnome Commander
Uwe Scholz's avatar
Uwe Scholz committed
20 21
in the [AUTHORS](AUTHORS) file.

22 23
### Distribution packages ###

24 25 26
Gnome Commander is
[available in distributions](https://gcmd.github.io/download.html#external)
like Fedora, Gentoo, Arch, etc.
27 28 29

## Contributing ##

Uwe Scholz's avatar
Uwe Scholz committed
30

31 32
### Ideas ###

Uwe Scholz's avatar
Uwe Scholz committed
33 34 35
If you have some good ideas for stuff you want to see in this program you
should check the [TODO](TODO) file first before filing a feature request.

36 37 38

### Translations ###

39
It would be great if you could help translating using [damned lies](https://l10n.gnome.org/).
40

Uwe Scholz's avatar
Uwe Scholz committed
41

42 43
### Cool hacks ###

44
Have a look in the [Gnome Wiki](https://wiki.gnome.org/GitLab#GitLab_workflow_for_code_contribution) how to contribute with new lines of code.
Uwe Scholz's avatar
Uwe Scholz committed
45

46
Don't forget to write a good explanation of what your patch does.
Uwe Scholz's avatar
Uwe Scholz committed
47 48


49
### Problem reporting ###
Uwe Scholz's avatar
Uwe Scholz committed
50

51
Bugs should be reported on [Gnome GitLab](https://gitlab.gnome.org/GNOME/gnome-commander/issues).
Uwe Scholz's avatar
Uwe Scholz committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
You will need to create an account for yourself.

In the bug report please include:

* Information about your system and anything else you think is relevant.
For instance:
  * What operating system and version
  * What version of X
  * What version of the gtk+, glib and gnome libraries
  * For Linux, what version of the C library
* How to reproduce the bug.
* If the bug was a crash, the exact text that was printed out when the
  crash occurred.
* Further information such as stack traces may be useful, but is not
  necessary. If you do send a stack trace, and the error is an X error,
  it will be more useful if the stack trace is produced running the test
  program with the --sync command line option.

70
Also, have a look at the list of known bugs on GitLab bevore opening a new bug.
71 72 73 74


## Building ##

75
Get the latest source from the [Gnome ftp server](https://download.gnome.org/sources/gnome-commander/).
Uwe Scholz's avatar
Uwe Scholz committed
76

77
```bash
Uwe Scholz's avatar
Uwe Scholz committed
78 79 80
~ » tar -xf gnome-commander-$VERSION.tar.xz # unpack the sources
~ » cd gnome-commander-$VERSION             # change to the toplevel directory
~ » ./configure                             # run the `configure' script
81
~ » make                                    # build Gnome Commander
82
  [ Become root if necessary ]
83
~ » make install                            # install Gnome Commander
84 85
```

86
For installing Gnome Commander using the sources in the git repository, do the following:
87 88

```bash
89
~ » git clone git@gitlab.gnome.org:GNOME/gnome-commander.git
90 91 92 93 94 95 96
~ » cd gnome-commander
~ » ./autogen.sh
~ » make
  [ Become root if necessary ]
~ » make install
```

Uwe Scholz's avatar
Uwe Scholz committed
97
After executing ``./configure`` or ``./autogen.sh`` see the file ``INSTALL``
98
for detailed information regarding the installation of Gnome Commander.
99 100 101

### Tip for working with git ###

102 103 104 105 106 107 108
There exists a git-scripts directory with a [pre-commit](pre-commit)
and a [pre-push](pre-push) hook. Just type ``ln -s ../../pre-commit
.git/hooks/pre-commit`` and vice verso for the pre-push hook to
activate each hook.

Both scripts run simple checks before actually committing or pushing
your source code changes.
109 110 111 112 113 114 115 116

### Docker ###

There exists also a [Dockerfile](Dockerfile) in the repository. At the
moment, it is for testing purposes for the Ubuntu distribution only,
i.e. when you do ``docker build .``, the GCMD sources are compiled on
the Ubuntu base image. Feel free to push a merge request if you have
cool ideas using Docker together with GCMD.