Madiator2011/Blender-Pipeline
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update 'wiki/docs/Installation.md'

Browse source
This commit is contained in:
Jeison Yehuda Amihud (Blender Dumbass) 2021-03-03 20:38:25 +00:00
parent 3154c7b923
commit 53b6d68149
1 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
wiki/docs/Installation.md
View file

@ -1,24 +1,24 @@
**NOTE:** *This Documentation Article is written for a specific verion of VCStudio mentioned in the title. If you have a newer version, some things might be changed. There could be a newer version of this article in the [wiki.](https://notabug.org/jyamihud/VCStudio/wiki/_pages) If there is non. Please be aware of possible changes. The Version could be found in the bottom, right corner of VCStudio* *This file is a test. Do not take it seriously. For now the WIKI is still the best way to read things.*
**COPYLEFT:** *This article is a part of* **VCStudio** *and might be used and reproduced using either* **GNU General Public License** *or* **CC-BY-SA**. [test button for readme](../../README.md)
[test readme](../../README.md)
# Installation # Installation
*I'm looking for a nice format for documentation. The file-format is Markdown .md. But I'm talking about the way it's going to be presented. So I'm playing around with it still. Don't take this documentation file seriously.*
### Content: ### Content:
- Video Tutorial - [Video Documentation](#video-documentation)
- Simple guide - [Text Documentation](#text-documentation)
- Advanced explanation - [Source Code](#source-code)
# Video Tutorial # Video Documentation
[![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/promotions/thumb_lbry_link.png)](https://open.lbry.com/@blender-organizer:5/rnd0001-4061:1?r=7YADjAZEbHJg8n4qV5rAuBh5Hca7cZQK) [![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/promotions/thumb_lbry_link.png)](https://open.lbry.com/@blender-organizer:5/rnd0001-4061:1?r=7YADjAZEbHJg8n4qV5rAuBh5Hca7cZQK)
![](../../settings/themes/OldSchool/icons/lbry.png) *Click on the image to view in LBRY* or ![](https://notabug.org/jyamihud/VCStudio/raw/master/settings/themes/OldSchool/icons/video.png) [Download Video](https://cdn.lbryplayer.xyz/api/v4/streams/free/rnd0001-4061/1f56bef7a754d6be38ea78d5ef0b6bb17952f517/ffd973) ![](../../settings/themes/OldSchool/icons/lbry.png) *Click on the image to view in LBRY* or ![](../../settings/themes/OldSchool/icons/video.png) [Download Video](https://cdn.lbryplayer.xyz/api/v4/streams/free/rnd0001-4061/1f56bef7a754d6be38ea78d5ef0b6bb17952f517/ffd973)
# Simple Guide # Text Documentation
To understand how to install VCStudio you need to understand a concept of scripts vs compiled software. Most software. Either the Linux kernel or Blender are compiled. The source code is read by a special program called a compiler and this program returns a binary file with direct instructions to the CPU. More often then not when installing software from the source code, from websites like NotABug or GitHub, you will need to run a special script that will do all the compilation and configuration for you. To understand how to install VCStudio you need to understand a concept of scripts vs compiled software. Most software. Either the Linux kernel or Blender are compiled. The source code is read by a special program called a compiler and this program returns a binary file with direct instructions to the CPU. More often then not when installing software from the source code, from websites like NotABug or GitHub, you will need to run a special script that will do all the compilation and configuration for you.
@ -70,7 +70,7 @@ On some systems it will also create an entry of the menu. So you will not need t
**Congradulations!** **Congradulations!**
# Advanced explanation # Source Code
*The folowing part of the article is for hard core nerdy people who want to know how everything works. And contains redundant information for a simple person that just want to use VCStudio. Anyway here it is.* *The folowing part of the article is for hard core nerdy people who want to know how everything works. And contains redundant information for a simple person that just want to use VCStudio. Anyway here it is.*
@ -78,11 +78,11 @@ On some systems it will also create an entry of the menu. So you will not need t
The best documentation is to read the code of the software directly. Here are the parts of VCStudio that are responsible for the disaster that is installation. The best documentation is to read the code of the software directly. Here are the parts of VCStudio that are responsible for the disaster that is installation.
- [run.py](https://notabug.org/jyamihud/VCStudio/src/master/run.py) Main file that operates the rest of the guts. - [run.py](../../run.py) Main file that operates the rest of the guts.
- [troubleshooter/troubleshooter.py](https://notabug.org/jyamihud/VCStudio/src/master/troubleshooter/troubleshooter.py) The file responsible for most of the checking and configuration process. - [troubleshooter/troubleshooter.py](../../troubleshooter/troubleshooter.py) The file responsible for most of the checking and configuration process.
- [settings/settings.py](https://notabug.org/jyamihud/VCStudio/src/master/settings/settings.py) File handling settings. - [settings/settings.py](../../settings/settings.py) File handling settings.
- [settings/talk.py](https://notabug.org/jyamihud/VCStudio/src/master/settings/talk.py) File handling languages. - [settings/talk.py](../../settings/talk.py) File handling languages.
- [settings/update.data](https://notabug.org/jyamihud/VCStudio/src/master/settings/update.data) File with update information. But in this case a file that holds a list of all files in the VCStudio program. - [settings/update.data](../../settings/update.data) File with update information. But in this case a file that holds a list of all files in the VCStudio program.
**So what is happening when you run the run.py?** **So what is happening when you run the run.py?**
@ -94,15 +94,15 @@ Basically on every startup it tries to make a system notification. Something lik
**What the troubleshooter does?** **What the troubleshooter does?**
Troubleshooter is a script to check / fix problems. Tho at the moment [fix.py](https://notabug.org/jyamihud/VCStudio/src/master/troubleshooter/fix.py) is empty of any functionality since there was no mistakes horrible enough found that troubleshooter should fix. This is why please [report your problems](https://notabug.org/jyamihud/VCStudio/issues). Troubleshooter is a script to check / fix problems. Tho at the moment [fix.py](../../troubleshooter/fix.py) is empty of any functionality since there was no mistakes horrible enough found that troubleshooter should fix. This is why please [report your problems](https://notabug.org/jyamihud/VCStudio/issues).
We can break the troubleshooter activity into 4 parts. We can break the troubleshooter activity into 4 parts.
- **Language**. Checking if there is any language in a settings and if not give user a little interface to choose a language. - **Language**. Checking if there is any language in a settings and if not give user a little interface to choose a language.
- **Check Python**. Basically checking the installed modules like Gtk, Cairo, PIL and so on. - **Check Python**. Basically checking the installed modules like Gtk, Cairo, PIL and so on.
- **Check VCStudio**. Checking all the files listed in [update.data](https://notabug.org/jyamihud/VCStudio/src/master/settings/update.data) that they exists and working. At this stage some files might fail without actually making too much problems. But these are fixes to make. - **Check VCStudio**. Checking all the files listed in [update.data](../../settings/update.data) that they exists and working. At this stage some files might fail without actually making too much problems. But these are fixes to make.
- **Make Desktop Entry**. If you read the first part of this documentation carefully. VCStudio adds it self into a system application menu. It does it using what's called a [Desktop Entry](https://freedesktop.org/wiki/Specifications/desktop-entry-spec/) that most GNU / Linux application launchers understand. - **Make Desktop Entry**. If you read the first part of this documentation carefully. VCStudio adds it self into a system application menu. It does it using what's called a [Desktop Entry](https://freedesktop.org/wiki/Specifications/desktop-entry-spec/) that most GNU / Linux application launchers understand.
**How is it launching the VCStudo it self the second time?** **How is it launching the VCStudo it self the second time?**
Well the second time the [talk.text()](https://notabug.org/jyamihud/VCStudio/src/master/settings/talk.py) function does not fail. So it's just continuing with the rest of the UI scripts. Mainy the [project_manager/pm_gtk.py](https://notabug.org/jyamihud/VCStudio/src/master/project_manager/pm_gtk.py). Well the second time the [talk.text()](https://notabug.org/jyamihud/VCStudio/src/master/settings/talk.py) function does not fail. So it's just continuing with the rest of the UI scripts. Mainy the [project_manager/pm_gtk.py](../../project_manager/pm_gtk.py).