github.com/mutagen-io/mutagen@v0.18.0-rc1/README.md (about)

     1  # Mutagen
     2  
     3  Mutagen is a new kind of remote development tool that enables your existing
     4  local tools to work with code in remote environments like cloud servers and
     5  containers. It does this by providing high-performance real-time
     6  [file synchronization](https://mutagen.io/documentation/synchronization) and
     7  flexible [network forwarding](https://mutagen.io/documentation/forwarding).
     8  It supports synchronization and forwarding between
     9  [local systems](https://mutagen.io/documentation/transports/local),
    10  [SSH-accessible locations](https://mutagen.io/documentation/transports/ssh),
    11  and [Docker containers](https://mutagen.io/documentation/transports/docker).
    12  
    13  
    14  ## Getting started
    15  
    16  The best way to understand Mutagen and its features is to read the
    17  [Overview](https://mutagen.io/documentation/introduction) and
    18  [Getting started](https://mutagen.io/documentation/introduction/getting-started)
    19  guides. You can find information about all of Mutagen's features in the
    20  [documentation](https://mutagen.io/documentation).
    21  
    22  
    23  ## Installation
    24  
    25  You can find
    26  [installation instructions](https://mutagen.io/documentation/introduction/installation)
    27  in the [Mutagen documentation](https://mutagen.io/documentation).
    28  
    29  
    30  ## Community
    31  
    32  The [Mutagen Community Slack Workspace](https://mutagen.io/slack) is the place
    33  to go for discussion, questions, and ideas.
    34  
    35  For updates about the project and its releases, you can
    36  [follow Mutagen on Twitter](https://twitter.com/mutagen_io).
    37  
    38  
    39  ## Status
    40  
    41  Mutagen is built and tested on Windows, macOS, and Linux, and it's available for
    42  [many more platforms](https://github.com/mutagen-io/mutagen/releases/latest).
    43  
    44  | Tests                               | Report card                         |
    45  | :---------------------------------: | :---------------------------------: |
    46  | [![Tests][tests-badge]][tests-link] | [![Report card][rc-badge]][rc-link] |
    47  
    48  [tests-badge]: https://github.com/mutagen-io/mutagen/workflows/CI/badge.svg "Test status"
    49  [tests-link]: https://github.com/mutagen-io/mutagen/actions "Test status"
    50  [rc-badge]: https://goreportcard.com/badge/github.com/mutagen-io/mutagen "Report card status"
    51  [rc-link]: https://goreportcard.com/report/github.com/mutagen-io/mutagen "Report card status"
    52  
    53  
    54  ## License
    55  
    56  For license information, please see the [LICENSE](LICENSE) file.
    57  
    58  
    59  ## Contributing
    60  
    61  If you'd like to contribute to Mutagen, please see the
    62  [contribution documentation](CONTRIBUTING.md).
    63  
    64  
    65  ## Security
    66  
    67  Mutagen takes security very seriously. If you believe you have found a security
    68  issue with Mutagen, please practice responsible disclosure practices and send an
    69  email directly to [security@mutagen.io](mailto:security@mutagen.io) instead of
    70  opening a GitHub issue. For more information, please see the
    71  [security documentation](SECURITY.md).
    72  
    73  
    74  ## Versioning and support
    75  
    76  Mutagen uses [semantic versioning](https://semver.org/) for tracking releases.
    77  Before Mutagen reaches version 1.0, each minor release series will be supported
    78  for one month after the first release in the next minor release series (e.g.
    79  v0.10.x will be supported until one month after the release of v0.11.0).
    80  
    81  The builds for each minor release series are pinned to the same Go minor release
    82  and dependency versions used for developing that series (though patch releases
    83  will be incorporated if they contain security fixes).
    84  
    85  We reserve the right to break or bend these rules if necessary for the sake of
    86  security, e.g. discontinuing support for a minor release to which a security fix
    87  cannot be backported or upgrading Go minor versions for a release series to
    88  incorporate important security fixes. Features marked as experimental may also
    89  see breakage when necessary, though we will endeavor to keep this to a minimum.
    90  
    91  
    92  ## Building
    93  
    94  Please see the [build instructions](BUILDING.md).
    95  
    96  
    97  ## External projects
    98  
    99  Users have built a number of cool projects to extend and integrate Mutagen into
   100  their workflows:
   101  
   102  - [**Mutagen Helper**](https://github.com/gfi-centre-ouest/mutagen-helper) is a
   103    tool that makes the orchestration of synchronization sessions even easier by
   104    letting you define sessions with configuration files that live inside your
   105    codebase. Thanks to [**@Toilal**](https://github.com/Toilal)!
   106  - [**docker-magento-mutagen**](https://github.com/mage2click/docker-magento-mutagen)
   107    (from [Mage2click](https://mage2.click/)) is a Docker-based development
   108    environment for Magento that uses Mutagen for file synchronization. Thanks to
   109    [**@u-maxx**](https://github.com/u-maxx) and
   110    [**@shkoliar**](https://github.com/shkoliar)!
   111  - [**MutagenMon**](https://github.com/rualark/MutagenMon) is a Python-based GUI
   112    for monitoring Mutagen sessions. Thanks to
   113    [**@rualark**](https://github.com/rualark)!
   114  - [**mutagenmon**](https://github.com/andrewmed/mutagenmon) is an alternative
   115    (Go-based) native GUI for Mac, for monitoring Mutagen sessions, provides apple
   116    notarized builds.
   117  
   118  
   119  ## Unrelated projects
   120  
   121  Please note that this project is unrelated to the
   122  [Mutagen](https://github.com/quodlibet/mutagen) Python module used for handling
   123  audio metadata.