-
Notifications
You must be signed in to change notification settings - Fork 240
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Reflect plan to accept bug fixes only
further edits shall make the instructions more future-proof
- Loading branch information
1 parent
a7919bc
commit 1818381
Showing
4 changed files
with
56 additions
and
148 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,9 @@ | ||
<!-- | ||
This issue tracker is dedicated to bugs and feature requests. | ||
This issue tracker is dedicated to bugs only. | ||
**IT IS NOT SUPPOSED FOR ANY USAGE RELATED QUESTIONS.** | ||
(sorry for that loud but necessary statement.) | ||
Stack Overflow is the go-to place for general questions and general how-tos. On | ||
SO, questions tagged with the 'cerberus' tag are actively monitored by the | ||
project author, contributors and users. If consultancy there leads you to the | ||
conclusion that the documentation should be improved, it is a valid bug report | ||
here. | ||
When reporting a bug, please post a full code example and make it as simple as | ||
possible. From your use-case throw everything out that is irrelevant to evoke | ||
the bug. | ||
**It is mandatory to provide the information in the template below:** | ||
Stack Overflow is the go-to place for general questions and general how-tos. | ||
https://stackoverflow.com/questions/tagged/cerberus | ||
--> | ||
|
||
Used Cerberus version / latest commit: … | ||
|
||
- [ ] I have the capacity to improve the docs when my problem is solved. | ||
- [ ] I have the capacity to submit a patch when a bug is identified. | ||
|
||
- [ ] My question does not concern a practical use-case that I can't figure out | ||
to solve. | ||
|
||
---- | ||
|
||
#### Use-case abstract | ||
|
||
<!-- please summarize your use-case --> | ||
|
||
---- | ||
|
||
#### Bug report / Feature request | ||
|
||
<!-- describe your issue here --> |
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
|
@@ -2,7 +2,10 @@ Cerberus Installation | |
===================== | ||
|
||
This part of the documentation covers the installation of Cerberus. The first | ||
step to using any software package is getting it properly installed. | ||
step to using any software package is getting it properly installed. Please | ||
refer to one of the many established ways to work in project-specific virtual | ||
environments, i.e. the `Virtual Environments and Packages`_ section of the | ||
Pyton documentation. | ||
|
||
|
||
Stable Version | ||
|
@@ -18,46 +21,16 @@ Cerberus is on the PyPI_ so all you need to do is: | |
Development Version | ||
------------------- | ||
|
||
Cerberus is actively developed in a `GitHub Repository`_ where the code. If you | ||
want to work with the development version, there are two ways: You can either | ||
let ``pip`` pull in the development version, or you can tell it to operate on a | ||
``git`` checkout. Either way, virtualenv is recommended. | ||
|
||
Get the git checkout in a new virtualenv and run in development mode. | ||
Obtain the source (either as source distribution from the PyPI, with ``git`` or | ||
other means that the Github platform provides) and use the following command | ||
in the source's root directory for an editable installation. Subsequent changes | ||
to the source code will affect its following execution without re-installation. | ||
|
||
.. code-block:: console | ||
$ git clone [email protected]:pyeve/cerberus.git | ||
Initialized empty Git repository in ~/dev/cerberus.git/ | ||
$ cd cerberus | ||
$ virtualenv venv --distribute | ||
New python executable in venv/bin/python | ||
Installing distribute............done. | ||
$ . venv/bin/activate | ||
$ pip install -e . | ||
... | ||
Finished processing dependencies for Cerberus | ||
This will pull in the dependencies and activate the git head as the current | ||
version inside the virtualenv. Then all you have to do is run ``git pull | ||
origin`` to update to the latest version. | ||
|
||
To just get the development version without git, do this instead: | ||
|
||
.. code-block:: console | ||
$ mkdir cerberus | ||
$ cd cerberus | ||
$ virtualenv venv --distribute | ||
$ . venv/bin/activate | ||
New python executable in venv/bin/python | ||
Installing distribute............done. | ||
$ pip install git+git://github.com/pyeve/cerberus.git | ||
... | ||
Cleaning up... | ||
And you're done! | ||
.. _GitHub Repository: https://github.com/pyeve/cerberus | ||
.. _PyPI: https://pypi.org/project/Cerberus | ||
.. _Virtual Environments and Packages: https://docs.python.org/3/tutorial/venv.html |