CryptoIM 0.1.1

Building

1. Get the source code at GitHub.

2. Build: python setup.py build and sudo python setup.py install

3. To run: python main.py

4. To run unit tests: python setup.py nosetests

5. To clean, run: python setup.py clean --all

6. To edit connection options, edit the main.cfg file.

Building on Linux

• Make sure to install these packages using your package manager: python and python-setuptools

• Follow steps 2., 3. and 6. from Building

Building on Windows

• Install Python and Setuptools.

• Follow steps 2., 3. and 6. from Building

Contributing

Everyone is encouraged to help improve this project.

Here are some ways you can contribute:

• by using alpha, beta, and prerelease versions

• by reporting bugs

• by suggesting new features

• by translating to a new language

• by writing or editing documentation

• by writing specifications

• by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)

• by refactoring code

• by closing issues

• by reviewing patches

Info

CryptoIM uses semantic versioning and branching model similar to this.

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn’t already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your Python version and operating system.

Submitting a Pull Request

1. Fork the repository.

2. Create a topic branch.

3. Implement your feature or bug fix.

4. Run python setup.py nosetests. If the tests fail, return to step 3.

5. If applicable, add tests for your feature or bug fix.

6. Add, commit, and push your changes.

7. Submit a pull request.