README.md 4.95 KB
Newer Older
Manuel Cortez's avatar
Manuel Cortez committed
1 2
# socializer 

Manuel Cortez's avatar
Manuel Cortez committed
3 4
[![pipeline status](https://code.manuelcortez.net/manuelcortez/socializer/badges/master/pipeline.svg)](https://code.manuelcortez.net/manuelcortez/socializer/commits/master)

Manuel Cortez's avatar
Manuel Cortez committed
5 6
> Note: this project has two different main repositories. [Here is the official repository, hosted in my Gitlab Instance,](https://code.manuelcortez.net/manuelcortez/socializer) [Here is a mirror repository hosted in GitHub.](https://github.com/manuelcortez/socializer) Github repository will accept pull requests and issues reported by github users, while Gitlab's repository will provide the wiki, documentation, and support for user reported issues.

Manuel Cortez's avatar
Manuel Cortez committed
7
A desktop application for handling [vk.com](https://vk.com) in an easy way.
Manuel Cortez's avatar
Manuel Cortez committed
8

Manuel Cortez's avatar
Manuel Cortez committed
9
[See Socializer's website](http://socializer.su)
Manuel Cortez's avatar
Manuel Cortez committed
10

Manuel Cortez's avatar
Manuel Cortez committed
11
> Note: this is the developer oriented documentation. If you want to read the user manual of socializer, [read the manual in the project's website](http://socializer.su/documentation)
Manuel Cortez's avatar
Manuel Cortez committed
12

Manuel Cortez's avatar
Manuel Cortez committed
13
## running
14

Manuel Cortez's avatar
Manuel Cortez committed
15
This document describes how to run Socializer from source and how to build a binary version which doesn't need Python and the other dependencies to run.
Manuel Cortez's avatar
Manuel Cortez committed
16

Manuel Cortez's avatar
Manuel Cortez committed
17
### Required dependencies
Manuel Cortez's avatar
Manuel Cortez committed
18

Manuel Cortez's avatar
Manuel Cortez committed
19
Although most dependencies (except Python) can be found in the windows-dependencies directory, we provide links to their official websites.
Manuel Cortez's avatar
Manuel Cortez committed
20

Manuel Cortez's avatar
Manuel Cortez committed
21 22 23 24
* [Python,](http://python.org) version 3.7.7

#### Dependencies that must be installed using pip

Manuel Cortez's avatar
Manuel Cortez committed
25 26
Python installs a tool called Pip that allows to install packages in a simple way. You can find it in the python scripts directory. To install packages using Pip, you have to navigate to the scripts directory using a command prompt, for example:  
    cd C:\python37\scripts
Manuel Cortez's avatar
Manuel Cortez committed
27 28

You can also add the scripts folder to your path environment variable or choose the corresponding option when installing Python.  
Manuel Cortez's avatar
Manuel Cortez committed
29 30 31 32 33
Pip is able to install packages listed in a special text file, called the requirements file. To install all remaining dependencies, perform the following command:  
    pip install -r requirements.txt  
Note that if you perform the command from the path where Pip is located, you need to specify the path to your Socializer root folder where the requirements file is located, for example:  
    pip install -r D:\repos\socializer\requirements.txt  

Manuel Cortez's avatar
Manuel Cortez committed
34
Pip will automatically get the additional libraries that the listed packages need to work properly.
Manuel Cortez's avatar
Manuel Cortez committed
35

Manuel Cortez's avatar
Manuel Cortez committed
36
If you need to update your dependencies, perform the following command:
Manuel Cortez's avatar
Manuel Cortez committed
37

Manuel Cortez's avatar
Manuel Cortez committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
pip install --upgrade -r requirements.txt

#### Other dependencies

These dependencies are located in the windows-dependencies directory. You don't need to install or modify them.

* Bootstrap 1.2.1: included in dependencies directory.  
This dependency has been built using pure basic 4.61. Its source can be found at http://hg.q-continuum.net/updater
* [oggenc2.exe,](http://www.rarewares.org/ogg-oggenc.php) version 2.87  
* Microsoft Visual c++ 2017 redistributable dlls.

#### Dependencies required to build the installer

* [NSIS,](http://nsis.sourceforge.net/) version 3.04

### Running Socializer from source

Now that you have installed all these packages, you can run Socializer from source using a command prompt. Navigate to the repo's `src` directory, and type the following command:

    python main.py

	If necessary, change the first part of the command to reflect the location of your python executable.

### Generating the documentation

To generate the documentation in html format, ensure you are in the doc folder inside this repo. After that, run these commands:  
Manuel Cortez's avatar
Manuel Cortez committed
64
    copy ..\changelog.md .  
Manuel Cortez's avatar
Manuel Cortez committed
65
    python document_importer.py  
Manuel Cortez's avatar
Manuel Cortez committed
66
    cd ..\src  
Manuel Cortez's avatar
Manuel Cortez committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
    python ..\doc\generator.py  

The documentation will be generated, placing each language in a separate folder in the doc directory.

### Building a binary version

A binary version doesn't need python and the other dependencies to run, it's the same version that you will find on the Socializer's website if you download the zip files or the Alpha versions.

To build it, run the following command from the src folder:

    python setup.py build

	You will find the binaries in the dist directory.

### Building an installer

If you want to install Socializer on your computer, you must create the installer first. Follow these steps:

* Navigate to the src directory, and Write the latest alpha version in the application file, so this version will be able to check updates and get the alpha channel: c:\python37\python.exe write_version_data.py
* create a binary version: C:\python37\python setup.py build
* run the installer script: C:\nsis\makensis.exe installer.nsi
Manuel Cortez's avatar
Manuel Cortez committed
88

Manuel Cortez's avatar
Manuel Cortez committed
89 90
## Contributing

Manuel Cortez's avatar
Manuel Cortez committed
91
If you are interested in this project, you can help it by [translating this program](https://code.manuelcortez.net/manuelcortez/socializer/wikis/translate) into your native language and give more people the possibility of using it. Thank you in advance!
Manuel Cortez's avatar
Manuel Cortez committed
92 93 94 95

## contact

If you have questions, don't esitate to contact me in [Twitter,](https://twitter.com/manuelcortez00) or sending me an email to manuel(at)manuelcortez(dot)net. Just replace the words in parentheses with the original signs.