docs: Move how to run from Git instructions
This commit is contained in:
parent
8362fbcdc5
commit
cf42161e1e
@ -37,10 +37,35 @@ Making changes
|
|||||||
- Improvements to the documentation get the prefix ``docs/``
|
- Improvements to the documentation get the prefix ``docs/``
|
||||||
|
|
||||||
|
|
||||||
|
.. _run-from-git:
|
||||||
|
|
||||||
|
Running Mopidy from Git
|
||||||
|
=======================
|
||||||
|
|
||||||
|
If you want to hack on Mopidy, you should run Mopidy directly from the Git
|
||||||
|
repo.
|
||||||
|
|
||||||
|
1. Go to the Git repo root::
|
||||||
|
|
||||||
|
cd mopidy/
|
||||||
|
|
||||||
|
2. To get a ``mopidy`` executable, run::
|
||||||
|
|
||||||
|
python setup.py develop
|
||||||
|
|
||||||
|
3. Now you can run the Mopidy command, and it will run using the code
|
||||||
|
in the Git repo::
|
||||||
|
|
||||||
|
mopidy
|
||||||
|
|
||||||
|
If you do any changes to the code, you'll just need to restart ``mopidy``
|
||||||
|
to see the changes take effect.
|
||||||
|
|
||||||
|
|
||||||
Testing
|
Testing
|
||||||
=======
|
=======
|
||||||
|
|
||||||
Mopidy got quite good test coverage, and we would like all new code going into
|
Mopidy has quite good test coverage, and we would like all new code going into
|
||||||
Mopidy to come with tests.
|
Mopidy to come with tests.
|
||||||
|
|
||||||
1. To run tests, you need a couple of dependencies. They can be installed using
|
1. To run tests, you need a couple of dependencies. They can be installed using
|
||||||
@ -79,6 +104,8 @@ Submitting changes
|
|||||||
Additional resources
|
Additional resources
|
||||||
====================
|
====================
|
||||||
|
|
||||||
|
- IRC channel: ``#mopidy`` at `irc.freenode.net <http://freenode.net/>`_
|
||||||
|
|
||||||
- `Issue tracker <https://github.com/mopidy/mopidy/issues>`_
|
- `Issue tracker <https://github.com/mopidy/mopidy/issues>`_
|
||||||
|
|
||||||
- `Mailing List <https://groups.google.com/forum/?fromgroups=#!forum/mopidy>`_
|
- `Mailing List <https://groups.google.com/forum/?fromgroups=#!forum/mopidy>`_
|
||||||
|
|||||||
@ -2,68 +2,6 @@
|
|||||||
Development
|
Development
|
||||||
***********
|
***********
|
||||||
|
|
||||||
Development of Mopidy is coordinated through the IRC channel ``#mopidy`` at
|
|
||||||
``irc.freenode.net`` and through `GitHub <https://github.com/>`_.
|
|
||||||
|
|
||||||
|
|
||||||
Feature wishlist
|
|
||||||
================
|
|
||||||
|
|
||||||
We maintain our collection of sane or less sane ideas for future Mopidy
|
|
||||||
features as `issues <https://github.com/mopidy/mopidy/issues>`_ at GitHub
|
|
||||||
labeled with `the "wishlist" label
|
|
||||||
<https://github.com/mopidy/mopidy/issues?labels=wishlist>`_. Feel free to vote
|
|
||||||
up any feature you would love to see in Mopidy, but please refrain from adding
|
|
||||||
a comment just to say "I want this too!". You are of course free to add
|
|
||||||
comments if you have suggestions for how the feature should work or be
|
|
||||||
implemented, and you may add new wishlist issues if your ideas are not already
|
|
||||||
represented.
|
|
||||||
|
|
||||||
|
|
||||||
.. _run-from-git:
|
|
||||||
|
|
||||||
Run Mopidy from Git repo
|
|
||||||
========================
|
|
||||||
|
|
||||||
If you want to contribute to the development of Mopidy, you should run Mopidy
|
|
||||||
directly from the Git repo.
|
|
||||||
|
|
||||||
#. First of all, install Mopidy in the recommended way for your OS and/or
|
|
||||||
distribution, like described at :ref:`installation`. You can have a
|
|
||||||
system-wide installation of the last Mopidy release in addition to the Git
|
|
||||||
repo which you run from when you code on Mopidy.
|
|
||||||
|
|
||||||
#. Then install Git, if haven't already. For Ubuntu/Debian::
|
|
||||||
|
|
||||||
sudo apt-get install git-core
|
|
||||||
|
|
||||||
On OS X using Homebrew::
|
|
||||||
|
|
||||||
sudo brew install git
|
|
||||||
|
|
||||||
#. Clone the official Mopidy repository::
|
|
||||||
|
|
||||||
git clone git://github.com/mopidy/mopidy.git
|
|
||||||
|
|
||||||
or your own fork of it::
|
|
||||||
|
|
||||||
git clone git@github.com:mygithubuser/mopidy.git
|
|
||||||
|
|
||||||
#. You can then run Mopidy directly from the Git repository::
|
|
||||||
|
|
||||||
cd mopidy/ # Move into the Git repo dir
|
|
||||||
python mopidy # Run python on the mopidy source code dir
|
|
||||||
|
|
||||||
How you update your clone depends on whether you cloned the official Mopidy
|
|
||||||
repository or your own fork, whether you have made any changes to the clone
|
|
||||||
or not, and whether you are currently working on a feature branch or not. In
|
|
||||||
other words, you'll need to learn Git.
|
|
||||||
|
|
||||||
For an introduction to Git, please visit `git-scm.com <http://git-scm.com/>`_.
|
|
||||||
Also, please read the rest of our developer documentation before you start
|
|
||||||
contributing.
|
|
||||||
|
|
||||||
|
|
||||||
Code style
|
Code style
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user