From f554c88b97952cfd2da64f0353f8965f3fc54157 Mon Sep 17 00:00:00 2001 From: abalabahaha Date: Sat, 30 Jan 2016 14:22:23 -0800 Subject: [PATCH] Docs version bump and slight updates --- docs/conf.py | 4 ++-- docs/installing.rst | 25 ++++++++++++++++++------- docs/migrating.rst | 14 +++++++------- docs/troubleshooting.rst | 3 ++- 4 files changed, 29 insertions(+), 17 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 5fb6a15a5..4e17370e0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,9 +55,9 @@ author = u'hydrabolt' # built documents. # # The short X.Y version. -version = '5.3' +version = '6.0.0' # The full version, including alpha/beta/rc tags. -release = '5.3.1' +release = '6.0.0a' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/installing.rst b/docs/installing.rst index f44224153..fb79a9fc4 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -14,10 +14,12 @@ Windows ------------ - - You need `Visual Studio`_ and `Python 2.7`_. +- You need `Visual Studio`_ and `Python 2.7`_. Your Visual Studio installation ideally has to be recent, but you can try installing without it first. You can use **Express, Community, Enteprise** or any others apart from ``VS Code``. +- You (obviously) need `NodeJS`_. Node 4 or higher is recommended. + After you have installed these things, to install just run: ``npm install --save --msvs_version=2015 discord.js`` to install the latest version of discord.js for your project. Additional Audio Support @@ -27,25 +29,34 @@ Additional Audio Support ----------- -Linux +Linux (Debian-based) ----- ----------- +- You (obviously) need `NodeJS Linux`_. Node 4 or higher is recommended. + .. code-block:: bash - $ apt-get install make build-essential + $ sudo apt-get install build-essential $ npm install --save discord.js - - - + + Additional Audio Support ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: bash - $ apt-get install ffmpeg libopus-dev + $ sudo apt-get install ffmpeg + +Note: Ubuntu 14.04 needs to do: + +.. code-block:: bash + + $ sudo add-apt-repository ppa:mc3man/trusty-media && sudo apt-get update && sudo apt-get install ffmpeg .. _Visual Studio : https://www.visualstudio.com/downloads/download-visual-studio-vs .. _Python 2.7 : https://www.python.org/download/releases/2.7.8/ .. _ffmpeg : https://www.ffmpeg.org/download.html +.. _NodeJS : https://nodejs.org/en/download/ +.. _NodeJS Linux : https://nodejs.org/en/download/package-manager/ \ No newline at end of file diff --git a/docs/migrating.rst b/docs/migrating.rst index 9a11a32bf..12cd8baac 100644 --- a/docs/migrating.rst +++ b/docs/migrating.rst @@ -21,24 +21,24 @@ Change 1 client.users.get(); client.servers.get(); client.members.get(); - + Change 2 -------- .. code-block:: js // OLD: - + client.on("serverNewMember", (member, server) => { - + }); - + // NEW: - + client.on("serverNewMember", (server, user) => { - + }); - + Change 3 --------- diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 3f5fa02ad..6542d5822 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -1,10 +1,11 @@ Troubleshooting =============== -Occasionally, the API can stop working for whatever reason. If it was working previously and it stopped working on the same version, it means that there's been a change to the Discord API. In this case, please `make an issue`_ if one relating to a similar issue doesn't exist. Please post a stacktrace if there is one, and be as detailed as possible - *"the API isn't working"* doesn't help at all. +Occasionally, the API can stop working for whatever reason. If it was working previously and it stopped working on the same version, it means that either we screwed code up or there's been a change to the Discord API. You can try asking around in the `discord.js channel in the API server`_. You could also `make an issue`_ if one relating to a similar issue doesn't exist. Please post a stacktrace if there is one, and be as detailed as possible - *"the API isn't working"* doesn't help at all. If there is already an issue, feel free to comment that you're also experiencing the same thing. This helps to see how widespread the bug is. You can try reconnecting before submitting an issue, as sometimes some of the servers may be slightly different. +.. _discord.js channel in the API server : https://discord.gg/0SBTUU1wZTYcFtmP .. _make an issue : https://github.com/hydrabolt/discord.js/issues \ No newline at end of file