Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
Signed-off-by: Kale Franz <[email protected]>
  • Loading branch information
kalefranz committed Jul 31, 2018
1 parent 6975b83 commit 49c9fa2
Showing 1 changed file with 13 additions and 49 deletions.
62 changes: 13 additions & 49 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,10 @@
:alt: latest release version
:target: https://github.com/conda/conda/releases

|
.. image:: https://s3.amazonaws.com/conda-dev/conda-announce-signup-button.svg
:alt: Join the Conda Announcment List
:target: https://conda.io/docs/help-support.html#conda-announcements-list

|

Conda is a cross-platform, language-agnostic binary package manager. It is the
package manager used by `Anaconda
<http://docs.continuum.io/anaconda/index.html>`_ installations, but it may be
<https://www.anaconda.com/download/>`_ installations, but it may be
used for other systems as well. Conda makes environments first-class
citizens, making it easy to create independent environments even for C
libraries. Conda is written entirely in Python, and is BSD licensed open
Expand All @@ -47,9 +40,9 @@ the amazing members of the conda community. Some of them can be found
Installation
------------

Conda is a part of the `Anaconda distribution <https://store.continuum.io/cshop/anaconda/>`_. You can also download a
minimal installation that only includes conda and its dependencies, called
`Miniconda <http://conda.pydata.org/miniconda.html>`_.
Conda is a part of the `Anaconda Distribution <https://repo.anaconda.com>`_.
Use `Miniconda <https://conda.io/miniconda.html>`_ to bootstrap a minimal installation
that only includes conda and its dependencies.


Getting Started
Expand Down Expand Up @@ -124,10 +117,12 @@ Building Your Own Packages
You can easily build your own packages for conda, and upload them
to `anaconda.org <https://anaconda.org>`_, a free service for hosting
packages for conda, as well as other package managers.
To build a package, create a recipe.
See http://github.com/conda/conda-recipes for many example recipes, and
http://docs.continuum.io/conda/build.html for documentation on how to build
recipes.
To build a package, create a recipe. Package building documentation is available
`here <https://conda.io/docs/user-guide/tasks/build-packages/index.html>`_.
See http://github.com/AnacondaRecipes for the recipes that make up the Anaconda Distribution
and ``defaults`` channel. `Conda-forge <https://conda-forge.org/feedstocks/>`_ and
`Bioconda <https://bioconda.github.io/recipes.html>`_ are community-driven
conda-based distributions.

To upload to anaconda.org, create an account. Then, install the
anaconda-client and login
Expand Down Expand Up @@ -158,44 +153,13 @@ to add).
Getting Help
------------

The documentation for conda is at http://conda.pydata.org/docs/. You can
The documentation for conda is at http://conda.io/docs/. You can
subscribe to the `conda mailing list
<https://groups.google.com/a/continuum.io/forum/#!forum/conda>`_. The source
code and issue tracker for conda are on `GitHub <https://github.com/conda/conda>`_.

Contributing
------------

Contributions to conda are welcome. Just fork the GitHub repository and send a
pull request.

To develop on conda, the easiest way is to use a development build. This can be
accomplished as follows:

* clone the conda git repository to a computer with conda already installed
* navigate to the root directory of the git clone
* run ``$CONDA/bin/python setup.py develop`` where ``$CONDA`` is the path to your
miniconda installation

Note building a development file requires git to be installed.

To undo this, run ``$CONDA/bin/python setup.py develop -u``. Note that if you
used a python other than ``$CONDA/bin/python`` to install, you may have to manually
delete the conda executable. For example, on OS X, if you use a homebrew python
located at ``/usr/local/bin/python``, then you'll need to ``rm /usr/local/bin/conda``
so that ``which -a conda`` lists first your miniconda installation.

If you are worried about breaking your conda installation, you can install a
separate instance of `Miniconda <http://conda.pydata.org/miniconda.html>`_ and
work off it. This is also the only way to test conda in both Python 2 and
Python 3, as conda can only be installed into a base environment.

To run the tests, set up a testing environment by running

* ``$CONDA/bin/python -m pip install -r utils/requirements-test.txt``.
* ``$CONDA/bin/python utils/setup-testing.py develop``

and then running ``py.test`` in the conda directory. You can also run tests using the
Makefile by running ``make unit``, ``make smoketest`` (a single integration test), or
``make integration``. The tests are also run by various CI systems when you make a
pull request.
Contributions to conda are welcome. See the `contributing <CONTRIBUTING.md>`_ documentation
for instructions on setting up a development environment.

0 comments on commit 49c9fa2

Please sign in to comment.