-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move the Installation page from README to docs installation page
Note that this also removes the git module installation option instructions, as this option is not somemthing most people will utilize. Git modules don't make much sense with python packages, which have their own dependency management tool (pip). The only advantage with git modules is that it's easier to understand where the source code is, and to see it, however this isn't really too important for us, and it's quite unnecessary.
- Loading branch information
Showing
3 changed files
with
26 additions
and
24 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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 @@ | ||
Move installation instructions from README to Installation docs page |
This file contains 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,5 +1,28 @@ | ||
Installation | ||
============ | ||
|
||
.. | ||
TODO: Write this | ||
PyPI (stable) version | ||
--------------------- | ||
|
||
Mcproto is available on `PyPI <https://pypi.org/project/mcproto/>`_, and can be installed trivially with: | ||
|
||
.. code-block:: bash | ||
python3 -m pip install mcproto | ||
This will install the latest stable (released) version. This is generally what you'll want to do. | ||
|
||
Latest (git) version | ||
-------------------- | ||
|
||
Alternatively, you may want to install the latest available version, which is what you currently see in the ``main`` | ||
git branch. Although this method will actually work for any branch with a pretty straightforward change. This kind of | ||
installation should only be done when testing new feautes, and it's likely you'll encounter bugs. | ||
|
||
That said, since mcproto is still in development, changes can often be made pretty quickly, and it can sometimes take a | ||
while for these changes to carry over to PyPI. So if you really want to try out that latest feature, this is the method | ||
you'll want. | ||
|
||
.. code-block:: bash | ||
python3 -m pip install 'mcproto@git+https://github.com/py-mine/mcproto@main' |