Changeset - 295900ff473d
[Not reviewed]
default
0 2 0
Andrew Shadura - 11 years ago 2015-03-12 09:43:05
andrew@shadura.me
docs: don't use fixed-width fonts when not needed
2 files changed with 7 insertions and 7 deletions:
0 comments (0 inline, 0 general)
README.rst
Show inline comments
 
@@ -2,13 +2,13 @@
 
Kallithea README
 
================
 

	
 
About
 
-----
 

	
 
``Kallithea`` is a fast and powerful management tool for Mercurial_ and Git_
 
**Kallithea** is a fast and powerful management tool for Mercurial_ and Git_
 
with a built-in push/pull server, full text search and code-review.
 
It works on http/https and has a built in permission/authentication system with
 
the ability to authenticate via LDAP or ActiveDirectory. Kallithea also provides
 
simple API so it's easy to integrate with existing external systems.
 

	
 
Kallithea is similar in some respects to GitHub_ or Bitbucket_,
 
@@ -90,13 +90,13 @@ Kallithea Features
 
- Based on Pylons, SQLAlchemy, SQLite, Whoosh, vcs.
 

	
 

	
 
License
 
-------
 

	
 
``Kallithea`` is released under the GPLv3 license. ``Kallithea`` is a
 
**Kallithea** is released under the GPLv3 license. Kallithea is a
 
`Software Freedom Conservancy`_ project and thus controlled by a non-profit organization.
 
No commercial entity can take ownership of the project and change the direction.
 

	
 
Kallithea started out as an effort to make sure the existing GPLv3 codebase would stay
 
available under a legal license. Kallithea thus has to stay GPLv3 compatible ...
 
but we are also happy it is GPLv3 and happy to keep it that way.
 
@@ -104,23 +104,23 @@ A different license (such as AGPL) could
 
with a different mix of Free Software people and companies but we are happy with the current focus.
 

	
 

	
 
Community
 
---------
 

	
 
``Kallithea`` is maintained by its users who contribute the fixes they would like to see.
 
**Kallithea** is maintained by its users who contribute the fixes they would like to see.
 

	
 
Get in touch with the rest of the community:
 

	
 
- Join the mailing list users and developers - see
 
  http://lists.sfconservancy.org/mailman/listinfo/kallithea-general.
 

	
 
- Use IRC and join #kallithea on FreeNode (irc.freenode.net)
 
  or use http://webchat.freenode.net/?channels=kallithea.
 

	
 
- Follow ``Kallithea`` on Twitter, **@KallitheaSCM**.
 
- Follow Kallithea on Twitter, **@KallitheaSCM**.
 

	
 
- Issues can be reported at `issue tracker <https://bitbucket.org/conservancy/kallithea/issues>`_.
 

	
 
   .. note::
 

	
 
       Please try to read the documentation before posting any issues, especially
docs/installation.rst
Show inline comments
 
.. _installation:
 

	
 
==========================
 
Installation on Unix/Linux
 
==========================
 

	
 
``Kallithea`` is written entirely in Python.  Kallithea requires Python version
 
**Kallithea** is written entirely in Python.  Kallithea requires Python version
 
2.6 or higher.
 

	
 
.. Note:: Alternative very detailed installation instructions for Ubuntu Server
 
   with celery, indexer and daemon scripts: https://gist.github.com/4546398
 

	
 

	
 
Installing Kallithea from Python Package Index (PyPI)
 
-----------------------------------------------------
 

	
 
``Kallithea`` can be installed from PyPI with::
 
**Kallithea** can be installed from PyPI with::
 

	
 
    pip install kallithea
 

	
 

	
 
Installation in virtualenv
 
--------------------------
 
@@ -134,13 +134,13 @@ installed Kallithea in::
 
will list all packages installed in the current environment.  If Kallithea
 
isn't listed, change virtual environments to your venv location::
 

	
 
 source /srv/kallithea/venv/bin/activate
 

	
 

	
 
Once you have verified the environment you can upgrade ``Kallithea`` with::
 
Once you have verified the environment you can upgrade Kallithea with::
 

	
 
 pip install --upgrade kallithea
 

	
 

	
 
Then run the following command from the installation directory::
 

	
0 comments (0 inline, 0 general)