-
Notifications
You must be signed in to change notification settings - Fork 160
early chapters reorganization + new Using Microphones and DJ Hardware chapters #60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 18 commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
4f6c08a
WIP DJ hardware refactor + microphone latency info
Be-ing a661f98
remove unnecessary sections from intro chapter
Be-ing 4ff5c0d
move DJ Hardware chapter later
Be-ing ca64cfa
line wrapping to 80 characters
Be-ing 63727ad
simplified Getting Started chapter and more detailed Preferences
Be-ing cbcc1cd
Getting Started chapter clarifications
Be-ing 5d046a9
Introduction chapter revisions
Be-ing 1c01b4b
Move details about Library out of Getting Started chapter
Be-ing 9be2938
Sound Hardware Preferences improvements
Be-ing f50067d
Getting Started formatting
Be-ing c8d3431
Intro chapter rewrite
Be-ing 63aec98
remove Installation chapter
Be-ing f0b2bec
reorder sections of Getting Started chapter
Be-ing 99455d0
move microphone documentation to its own chapter
Be-ing 25e75ad
improve Latency Compensation section
Be-ing 232046b
revise manual intro and first chapter
Be-ing 038fb71
first complete draft of the new Using Microphones chapter
Be-ing 99a3770
reword Using Microphones chapter intro
Be-ing ed9cb57
replace IRC with Zulip
Be-ing 6327721
remove extraneous details
Be-ing 4104e79
break paragraphs into step-by-step instructions for microphones chapter
Be-ing 2fa458a
replace "soundcard" and "sound card" with "audio interface"
Be-ing 9a1bf95
make text more consistent in Using Microphones chapter
Be-ing dcd0cce
Using Microphones chapter edits
Be-ing 4b42f0e
link to new Using Microphone chapter from other places in the manual
Be-ing f07cab5
continue replacing "soundcard" with "audio interface"
Be-ing 9436b81
add notes about phantom power and condenser mics
Be-ing 799f857
split Example Setups to its own chapter and add to DJ Hardware chapter
Be-ing 75bc182
add suggestion about hardware on/off switch on some mics
Be-ing f76a6cf
give some estimates of the different storage space requirements of FL…
Be-ing File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,45 @@ | ||
|
|
||
| Appendix | ||
| ******** | ||
|
|
||
| Additional Resources | ||
| ==================== | ||
|
|
||
| .. sectionauthor:: | ||
| S.Brandt <s.brandt@mixxx.org> | ||
|
|
||
| Got questions? Need more information? Want to :ref:`contribute <contributing>`? | ||
| There are a variety of other resources where you can find out more: | ||
|
|
||
| * **Mixxx Website**: For general information and updates, as well as the latest | ||
| news on Mixxx, go to: `<http://mixxx.org>`_ | ||
|
|
||
| * **Mixxx Wiki**: For up-to-date information about supported DJ hardware, | ||
| documentation on making controller mappings, and other tips and tricks, go to: | ||
| `<https://mixxx.org/wiki/doku.php>`_ | ||
|
|
||
| * **Mixxx Community Forums**: To search for answers, post your question or | ||
| answer other DJ's questions, go to: `<http://mixxx.org/forums>`_ | ||
|
|
||
| * **Mixxx IRC Chat Channel**: Join the #mixxx channel on the | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is IRC stalled now? If yes, we should remove this link. |
||
| `Freenode IRC Network <http://www.freenode.net/>`_ for support or to chat with | ||
| other Mixxx users and developers. A web page for accessing the IRC channel is | ||
| available at `<https://mixxx.org/irc>`_ | ||
|
|
||
| * **Mixxx Source Code**: To download the source code for Mixxx, go to: | ||
| `<https://github.com/mixxxdj/mixxx>`_ | ||
|
|
||
| * **Mixxx Bug Tracker**: To report a bug or request a feature, go to: | ||
| `<https://bugs.launchpad.net/mixxx>`_ | ||
|
|
||
| * **Mixxx Translations**: To translate Mixxx and promote your mother tongue, go | ||
| to: `<https://www.transifex.com/mixxx-dj-software/public/>`_ . Please | ||
| read the `Translation FAQ <http://mixxx.org/wiki/doku.php/internationalization>`_ | ||
| first. | ||
|
|
||
| * **Social Media**: Follow us on `Twitter <https://twitter.com/mixxxdj>`_ , | ||
| `Facebook <https://www.facebook.com/pages/Mixxx-DJ-Software/21723485212>`_ , | ||
| and `Google+ <https://plus.google.com/+mixxx/posts>`_ . | ||
|
|
||
| .. _appendix-keyboard: | ||
|
|
||
| Keyboard mapping table | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| .. include:: /shortcuts.rstext | ||
|
|
||
| .. _getting-started-mixxx: | ||
|
|
||
| Getting Started | ||
| *************** | ||
|
|
||
| Opening Mixxx | ||
| ============= | ||
| |logo| Once you've :ref:`installed Mixxx <installing-mixxx>`, start by opening | ||
| Mixxx and importing your music to the Mixxx library. | ||
|
|
||
| **Windows** | ||
| Double-click the Mixxx icon on the Desktop. Alternatively, browse your Windows | ||
| start menu and click the Mixxx icon, or perform a search for | ||
| :file:`Mixxx.exe`. | ||
|
|
||
| **Mac OSX** | ||
| Double-click the Mixxx icon in the :file:`Applications` folder. Alternatively, | ||
| drag the Mixxx icon to the dock and double-click it there or search for | ||
| :command:`mixxx` in Spotlight. | ||
|
|
||
| **GNU/Linux** | ||
| Click the Mixxx icon in the applications menu or launcher of your desktop | ||
| environment or perform a search for :file:`mixxx`. Alternatively type | ||
| :command:`mixxx` into the terminal, then hit :kbd:`Return`. | ||
| If your :term:`soundcard` is not accessible from Mixxx because it is used by | ||
| other applications via PulseAudio, you may close and restart Mixxx using | ||
| :command:`pasuspender mixxx`. See :ref:`appendix-command-line-options` for an | ||
| overview of Mixxx's command line options. | ||
|
|
||
| .. _getting-started-import-audio-files: | ||
|
|
||
| Importing your audio files | ||
| ========================== | ||
|
|
||
| .. sectionauthor:: | ||
| S.Brandt <s.brandt@mixxx.org> | ||
|
|
||
| .. figure:: ../_static/Mixxx-200-1st-run-choose-library-directory-win.png | ||
| :align: center | ||
| :width: 50% | ||
| :figwidth: 100% | ||
| :alt: Mixxx 1st run - Choose music library directory dialog | ||
| :figclass: pretty-figures | ||
|
|
||
| Mixxx running on Windows 10 - Choose music library directory dialog | ||
|
|
||
| The first time you run Mixxx, you are asked to select a directory where your | ||
| music is stored. By default, the dialog points to a location where music files | ||
| are typically held, but you can select any location on your computer. | ||
|
|
||
| Click :guilabel:`Select Folder` and Mixxx will scan your music library. | ||
| Depending on the size of your library this could take some time. All the | ||
| supported music files Mixxx detects will be listed in the :ref:`library-root`. | ||
|
|
||
| If you want to refresh your library (for example because you added or moved | ||
| files), you can do this with :menuselection:`Library --> Rescan Library` in | ||
| the menu. If you want to rescan at every launch, select | ||
| :menuselection:`Preferences --> Library --> Rescan on startup`. | ||
|
|
||
| .. warning :: On Windows 7 and 8 the import dialog points to your Windows | ||
| “Music“ Library, a special-purpose virtual folder. You can | ||
| **not** use these virtual folders. Select a regular folder | ||
| instead, usually “My Music“, like pictured above. | ||
|
|
||
| .. _getting-started-analyze-library: | ||
|
|
||
| Analyze your library | ||
| ==================== | ||
|
|
||
| .. sectionauthor:: | ||
| RJ Ryan <rryan@mixxx.org> | ||
| S.Brandt <s.brandt@mixxx.org> | ||
|
|
||
| |ic_lib_prepare| Mixxx automatically analyzes tracks the first time you load | ||
| them in a deck, nevertheless it is recommended that you analyze them before | ||
| playing live to ensure the beatgrids are correct. Furthermore, track | ||
| analysis takes considerable CPU power and might cause skips in the audio --- | ||
| things you surely don't need while performing. | ||
|
|
||
| Once you have configured your music directories and your BPM and key detection | ||
| settings, press :guilabel:`OK` on the Preferences window. Go to the Analyze | ||
| view on the left side panel of the library. This allows you to run | ||
| :term:`beatgrid`, :term:`key`, and :term:`ReplayGain` detection on tracks in | ||
| advance. While analyzing, the progress in percentage and total queue length are | ||
| shown. | ||
|
|
||
| The Analyze features in detail: | ||
|
|
||
| * **All / New radio-buttons**: Allows you to view a list of either all tracks in | ||
| the library or tracks added to the library within the last 7 days. | ||
| * **Select All button**: Selects all tracks in the current view. | ||
| * **Analyze button**: Starts the detection on the selected tracks. | ||
|
|
||
| .. seealso:: For more information, go to :ref:`configuration-bpm-detection`. | ||
|
|
||
| .. _getting-started-sound-io: | ||
|
|
||
| Configuring sound input and output | ||
| ================================== | ||
|
|
||
| Before you can start using Mixxx, you need to configure Mixxx to use your | ||
| sound hardware in :menuselection:`Preferences --> Sound Hardware`. At a | ||
| minimum, one output must be configured. You do not need to configure all inputs | ||
| and outputs. | ||
|
|
||
| The :ref:`hardware` chapter explains different types of DJ hardware and how to | ||
| set them up with the the input and output options. For Mixxx to perform the best | ||
| it can on your system, configure the other :ref:`preferences-sound-hardware` | ||
| preferences in addition to the inputs and outputs. | ||
|
|
||
| .. figure:: ../_static/Mixxx-200-Preferences-Soundhardware.png | ||
| :align: center | ||
| :width: 80% | ||
| :figwidth: 100% | ||
| :alt: Mixxx Sound Hardware Preferences | ||
| :figclass: pretty-figures | ||
|
|
||
| Mixxx Sound Hardware Preferences | ||
|
|
||
| Output Options | ||
| -------------- | ||
|
|
||
| **Internal mixing**: | ||
|
|
||
| Use these outputs if you are not using an external hardware mixer. If you are | ||
| using a controller with a built in soundcard, use these outputs. | ||
|
|
||
| * *Master*: all decks, samplers, microphones, and auxiliary inputs mixed | ||
| together. This output is sent to the speakers for the audience. | ||
| * *Headphones*: all decks, samplers, microphones, and auxiliary inputs | ||
| assigned to :term:`pre-fader listening <PFL>` | ||
| * *Booth*: same as Master output, but has a separate gain control | ||
|
|
||
| **External mixing**: | ||
|
|
||
| * *Decks 1-4*: the individual unmixed decks to send to an external mixer | ||
| * *Bus Left/Center/Right*: all decks, samplers, and auxiliary inputs | ||
| assigned to each side of Mixxx's crossfader | ||
|
|
||
| Input Options | ||
| ------------- | ||
|
|
||
| **Internal mixing**: | ||
|
|
||
| Use these inputs if you are not using an external hardware mixer. If you are | ||
| using a controller with a built in soundcard, use these inputs. | ||
|
|
||
| * *Microphone 1-4*: live microphone or musical instrument inputs | ||
| * *Auxiliary 1-4*: other sound sources | ||
|
|
||
| **External mixing**: | ||
|
|
||
| * *Record/Broadcast*: When this is configured, Mixxx will record and | ||
| broadcast from this soundcard input instead of the internal master mix. If | ||
| you have a microphone plugged into the mixer, do not configure the Microphone | ||
| 1-4 inputs. | ||
|
|
||
| **Either internal or external mixing**: | ||
|
|
||
| * *Vinyl Control 1-4*: timecode input from turntables or CDJs for | ||
| manipulating decks 1-4 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we omit /doku.php here? For the case we change anything on the wiki software.