Skip to content

Commit

Permalink
Move the Installation page from README to docs installation page
Browse files Browse the repository at this point in the history
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
ItsDrike committed Jun 24, 2023
1 parent bb62f51 commit 1d59cd2
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 24 deletions.
22 changes: 0 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,6 @@ real-world playable server).
Currently, the library is very limited and doesn't yet have any documentation, so while contributions are welcome, fair
warning that there is a lot to comprehend in the code-base and it may be challenging to understand it all.

## Installation

Mcproto is available on [PyPI](https://pypi.org/project/mcproto/), and can be installed trivially with:

```bash
python3 -m pip install mcproto
```

That said, as mcproto is still in development, the PyPI version will likely go out of date quite soon. This means that
it may lack some already implemented features, or contain already fixed bugs. For that reason, you can also consider
installing mcproto through git, to get the most recent version. But know that while this will mean you'll be getting
all of the new features, this version is much more likely to contain bugs than the one on PyPI, so make your decision
wisely. To install the latest version from git, you can use the command below:

```bash
python3 -m pip install 'mcproto @ git+https://github.com/py-mine/mcproto@main'
```

Alternatively, if you want to poke around with mcproto's code, you can always include mcproto as a full [git
submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to your project, or just git clone it directly and play
around with it from REPL.

## Examples

Since there is no documentation, to satisfy some curious minds that really want to use this library even in this
Expand Down
1 change: 1 addition & 0 deletions changes/141.docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Move installation instructions from README to Installation docs page
27 changes: 25 additions & 2 deletions docs/pages/installation.rst
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'

0 comments on commit 1d59cd2

Please sign in to comment.