From 85554eacd1fcfc86e5dc9ff368dca3a70c3df6f9 Mon Sep 17 00:00:00 2001 From: ingvar1995 Date: Sat, 4 Mar 2017 23:35:46 +0300 Subject: [PATCH] docs updates --- README.md | 6 +++--- docs/compile.md | 1 + docs/contributing.md | 8 ++++---- docs/install.md | 2 +- docs/plugin_api.md | 2 +- docs/plugins.md | 2 +- docs/smileys_and_stickers.md | 2 +- 7 files changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 727559a..ff70b47 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ Toxygen is powerful cross-platform [Tox](https://tox.chat/) client written in pure Python3. -[![Release](https://img.shields.io/github/release/xveduk/toxygen.svg?style=flat)](https://github.com/toxygen-project/toxygen/releases/latest) -[![Stars](https://img.shields.io/github/stars/xveduk/toxygen.svg?style=flat)](https://github.com/toxygen-project/toxygen/stargazers) -[![Open issues](https://img.shields.io/github/issues/xveduk/toxygen.svg?style=flat)](https://github.com/toxygen-project/toxygen/issues) +[![Release](https://img.shields.io/github/release/toxygen-project/toxygen.svg?style=flat)](https://github.com/toxygen-project/toxygen/releases/latest) +[![Stars](https://img.shields.io/github/stars/toxygen-project/toxygen.svg?style=flat)](https://github.com/toxygen-project/toxygen/stargazers) +[![Open issues](https://img.shields.io/github/issues/toxygen-project/toxygen.svg?style=flat)](https://github.com/toxygen-project/toxygen/issues) [![License](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat)](https://raw.githubusercontent.com/toxygen-project/toxygen/master/LICENSE.md) [![Build Status](https://travis-ci.org/toxygen-project/toxygen.svg?branch=master)](https://travis-ci.org/toxygen-project/toxygen) diff --git a/docs/compile.md b/docs/compile.md index 5b2b5fe..995dc35 100644 --- a/docs/compile.md +++ b/docs/compile.md @@ -5,6 +5,7 @@ You can compile Toxygen using [PyInstaller](http://www.pyinstaller.org/) Install PyInstaller: ``pip3 install pyinstaller`` +Compile Toxygen: ``pyinstaller --windowed --icon images/icon.ico main.py`` Don't forget to copy /images/, /sounds/, /translations/, /styles/, /smileys/, /stickers/, /plugins/ (and /libs/libtox.dll, /libs/libsodium.a on Windows) to /dist/main/ diff --git a/docs/contributing.md b/docs/contributing.md index 8b1e7fa..35bd650 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -4,15 +4,15 @@ Help us find all bugs in Toxygen! Please provide following info: - OS - Toxygen version -- Toxygen executable info - .py or precompiled binary +- Toxygen executable info - .py or precompiled binary, how was it installed in system - Steps to reproduce the bug -Want to see new feature in Toxygen? [Ask for it!](https://github.com/xveduk/toxygen/issues) +Want to see new feature in Toxygen? [Ask for it!](https://github.com/toxygen-project/toxygen/issues) #Pull requests -Developer? Feel free to open pull request. Our dev team is small so we glad to get help. -Don't know what to do? Improve UI, fix [issues](https://github.com/xveduk/toxygen/issues) or implement features from our TODO list. +Developer? Feel free to open pull request. Our dev team is small so we glad to get help. +Don't know what to do? Improve UI, fix [issues](https://github.com/toxygen-project/toxygen/issues) or implement features from our TODO list. You can find our TODO's in code, issues list and [here](/README.md). Also you can implement [plugins](/docs/plugins.md) for Toxygen. #Translations diff --git a/docs/install.md b/docs/install.md index 637ec8f..808eb93 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,7 +1,7 @@ # How to install Toxygen ## Use precompiled binary: -[Check our releases page](https://github.com/xveduk/toxygen/releases) +[Check our releases page](https://github.com/toxygen-project/toxygen/releases) ## Using pip3 diff --git a/docs/plugin_api.md b/docs/plugin_api.md index f523270..3c45b84 100644 --- a/docs/plugin_api.md +++ b/docs/plugin_api.md @@ -53,5 +53,5 @@ Plugin's methods MUST NOT raise exceptions. #Examples -You can find examples in [official repo](https://github.com/ingvar1995/toxygen_plugins) +You can find examples in [official repo](https://github.com/toxygen-project/toxygen_plugins) diff --git a/docs/plugins.md b/docs/plugins.md index ee73415..fee1fe4 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -19,4 +19,4 @@ Toxygen comes without preinstalled plugins. WARNING: It is unsecure to install plugin not from this list! -[Main repo](https://github.com/ingvar1995/toxygen_plugins) \ No newline at end of file +[Main repo](https://github.com/toxygen-project/toxygen_plugins) \ No newline at end of file diff --git a/docs/smileys_and_stickers.md b/docs/smileys_and_stickers.md index 53a360b..e34a888 100644 --- a/docs/smileys_and_stickers.md +++ b/docs/smileys_and_stickers.md @@ -10,4 +10,4 @@ Animated smileys (.gif) are supported too. Sticker is inline image. If you want to create your own smiley pack, create directory in src/stickers/ and place your stickers there. -Users can import plugins and stickers packs using menu: Settings -> Interface \ No newline at end of file +Users can import smileys and stickers using menu: Settings -> Interface