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

Polish for 21.0303

Browse source 
I needed to rewrite the document a
bit. So to make it more friendly to the
users. And to clarify some things. As well
as to make it work better with the built in
Markdown browser.
This commit is contained in:
Jeison Yehuda Amihud (Blender Dumbass) 2021-03-04 22:39:42 +00:00
parent ec6b0f6edd
commit cf13320d26
1 changed files with 62 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

113
wiki/docs/Installation.md
View file

@ -1,81 +1,92 @@
*This file is a test. Do not take it seriously. For now the WIKI is still the best way to read things.* **VCStudio Documentation**
[test button for readme](../../README.md) *(C) J.Y.Amihud 2021. Under GPL v3 or later. Please note that documentation files are not perfect. And need maintenance. You can help us do this by editing them on* [NotABug](https://notabug.org/jyamihud/VCStudio).
# 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.* This is the installation guide. *If you are reading it from the build in documentation inside the VCStudio. You probably don't need it already.* This is a guide that will allow users to understand how to put VCStudio on their machine. This is hopefully needed to be done ones. Tho some problems could occur that will make you need this document more then ones. Nobody is perfect. Software always will have bugs.
### Content: **Content:**
- [Video Tutorial](#video-tutorial)
- [Video Documentation](#video-documentation) - [Simple Guide](#simple-guide)
- [Text Documentation](#text-documentation) - [Troubleshooting](#troubleshooting)
- [Source Code](#source-code) - [Source Code](#source-code)
# 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)
# Video Tutorial
*LBRY is a decentralized alternative to YouTube that works on Block-Chain technology. They are Free Software. Tho JavaScripts might not work under [LibreJS](https://www.gnu.org/software/librejs/). They have an issue about it on the sites [Git repository](https://github.com/lbryio/lbrytv/issues/312). You can help a bit by yelling at them too. For now you can whitelist them. Similar to GitLab the License is fine. It's just lacking notices on individual files.*
[![](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 ![](../../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)
# Text Documentation # Simple Guide
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. This part will be basic. It's going to break up the step by step installation for simple user that doesn't want to know much. I will advice you to read the rest of the document anyway. Don't be afraid of knowledge.
On the other hand you have scripts. Which are run in a program called an interpriter. Python is one such program. And the source code of VCStudio writen so to run in a Python 3 interpriter. **Step 1: Operating system.** As mentioned in the Windows? section in the [readme](../../README.md) file, VCStudio is not designed to run smoothly on Windows. I don't know maybe it will. I just have no Windows near me to test. More then that, if you run Windows, I will recommend you to [upgrade from Windows](https://fsf.org/windows) since it's proprietary nature abuses your human rights.
### Need to install: I'm developing and testing the software on GNU / Linux operating system. GNU / Linux is Free Software. Meaning you are in control over what the computer is doing. And not some company. I would not advice people to give away their control or their freedom. So I will not tolerate use of proprietary programs. Unless if it's to put an end to them. *(Using Facebook to tell people to get off of Facebook is okay.)*
We need to have a few things installed before we can run VCStudio: For 100% Freedom respecting Operating Systems you may want to look at [this page.](http://gnu.org/distros) Tho keep in mind that some hardware could stop working because it's not going to be supported by 100% free software system. You can see if your hardware is supported [here.](https://h-node.org/) If your hardware is not supported don't be sad. You can still get an almost free system. Which is a huge step towards freedom. And should not be disregarded. Systems like [Ubuntu](https://ubuntu.com/) and [Mint](https://linuxmint.com/) are a viable first step. They are not 100% free, but they do support most hardware. So for migration period they will be fine. See [this page](https://www.gnu.org/distros/common-distros.html) on why they are not recommended to use forever.
- **GNU / Linux**. VCStudio was built for GNU / Linux operating system. Which is a Free Software alternative to programs like Microsoft Windows or Apple's OS. What ever the name is. While you can technically make it run on any operating system, some unintentional bugs will accure since nothing other then GNU / Linux was tested when writing VCStudio. So I highly advice to use GNU / Linux for this. To install the chosen operating system on the hardware you will need to follow a few steps.
If you are new to GNU / Linux you can try various [popular destributions.](https://distrowatch.com/dwres.php?resource=major) And if you want to use only [Free Software](https://www.fsf.org/) please look at the [GNU certified destributions.](https://www.gnu.org/distros/free-distros.html) 1. **Get the ISO of the system.** It a downloadable file that you can get on a web site of the Operating System. Usually it's in an ISO format.
- **Python 3**. As I mentioned earlier we need an interpriter. And the code is written to work with Python 3. Most GNU / Linux Destributions will have it pre-installed. You can see the version of the python installed by launching the terminal and typing `python3` into it. If it's not there. Please install it. 2. **Install the ISO on a USB drive.** This step will require you to research a bit if you are not already on GNU / Linux variant. On GNU / Linux you can use the Startup Disk Creator tool. *I'm not a Windows user. But I remember there was a program to make such USBs on Windows.*
3. **Configure BIOS or Coreboot to load from USB.** In the BIOS you could probably find a setting from what drive the computer will try loading the Operating System.
4. **Install the Free OS.** The USB you created will be a little Operating System by it self. It's usually an Installer OS. Which will let you configure things like Language, file-system, user-name and password. It's usually not to difficult to understand them if you read everything carefully.
**Step 2: Get a copy of VCStudio.** This is very simple. Just download [this file](https://notabug.org/jyamihud/VCStudio/archive/master.tar.gz). And extract it in a preferred folder. I usually have a Software directory in my home folder. I would extract it there.
**Step 3: Run configuration.** For this we need to open the terminal and navigate to the correct directory. The simple way is to right-click on the folder and choose "Open In Terminal" in order to get a terminal open in the directory of the folder. If you have no option like this in your file-browser, open the terminal and use the `cd <folder_name>` command to navigate to the folder where you extracted the downloaded package. `ls` could be handy to list all items in the current folder you are in. Use `cd ..` if you need to navigate back. When successfully navigated to the folder run `python3 run.py`.
I know that the previous paragraph could be a little bit intimidating. Especially if you are new to GNU / Linux. But please be patient. Terminal is your friend. It's not there to hurt you. It's just a bit different. You have to actually type words to use it. If you didn't get it. Read the previous paragraph again and pause after each sentence.
![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/45.png)
It should present you with something like this. Maybe in different colors. This is the Language menu of the program. Type `English` and continue. *Of course you can type any other language as well. But make sure you understand it before typing it.*
As soon as you type it. There will be a first check of the program. It's gonna run a quick test to see that all the files are indeed in the folder. And will tell you if something is missing or broken. Please [report](https://notabug.org/jyamihud/VCStudio/issues) if something is broken.
![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/46.png)
It should launch a window like this if everything worked fine. Now you probably can find VCStudio in your application menu.
![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/47.png)
Done!
# Troubleshooting
You may encounter various problems in the previous few steps. If you do you have to broaden your understanding of what exactly you are doing. This is not hard, but is not necessary for installation most of the time. So I didn't include it up there.
To understand the installation of 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 contains direct instructions to the CPU. Which are extremely hard to read if you are a human. 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.
In other words. Most programs are compiled.
On the other hand you have scripts. Which run directly from the source code in a program called the interpriter. Python is one such program. And the source code of VCStudio writen so to run in a Python 3 interpreter.
Most GNU / Linux Destributions will have it pre-installed with Python 3. You can see the version of the python installed by launching the terminal and typing `python3` into it. If it's not there. Please install it.
![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/43.png) ![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/43.png)
- **Py-GTK**. For python 3 there should be installed a whole suit of GTK Graphical Toolkit modules. Without them the program will fail to draw a window. To test that they are installed you can type `from gi.repository import Gtk` to the python console. A lot of programs contain everything you need in them. But usually it's a huge waste of storage. Sometimes one library can be shared between 2 programs just fine. For example the GTK library to draw Graphical User Interfaces. It can be used by more then one program. And it's probably good to have one installed for all of them. Instead of having multiple copies of the same library for each program.
**Py-GTK** is a python module to draw GUI using a GTK library. To test that it is installed you can type `from gi.repository import Gtk` to the python console.
![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/44.png) ![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/44.png)
A warning such as `<stdin>:1: PyGIWarning:` is okay. As long it does not say something like `ModuleNotFoundError: No module named 'Gtk'` A warning such as `<stdin>:1: PyGIWarning:` is okay. As long it does not say something like `ModuleNotFoundError: No module named 'Gtk'`
### Get a copy of VCStudio Now you can start the installation guide again. This time with a lot more knowledge. But this is not the end still. Because the following chapter going to be even more insightful into your problem. Or if you have non, as I said. Don't be afraid of knowledge.
You can get a copy of VCStudio in a ZIP format [here.](https://notabug.org/jyamihud/VCStudio/archive/master.zip) or by using `git` in terminal. Be aware, not all systems come with git by default.
`git clone https://notabug.org/jyamihud/VCStudio`
### Get into the folder with terminal
The first launch of VCStudio will be a kind of installation run. So we need to do it from the terminal. For this unpack the ZIP and `cd` into the folder. *In case you got a copy using git simply use* `cd VCStudio`. In most modern file managers on GNU / Linux you will have an option to open a folder in terminal when clicking on the folder with right mouse button.
### First run
Now you can run VCStudio. Type into the terminal `python3 run.py` and hit Enter. You will see a window like this one.
![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/45.png)
Just type in the language you are most confortable with from the list. And press enter. It will launch a thing called troubleshooter. It will check all the scripts and give you information if something is currently wrong with the your copy. If you see anything failed please [report to us.](https://notabug.org/jyamihud/VCStudio/issues)
Now just repeat the last command `python3 run.py` and if everything is okay you will launch the UI of the progect manager.
![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/46.png)
On some systems it will also create an entry of the menu. So you will not need to launch a terminal every time you want to use VCStudio.
![](https://notabug.org/jyamihud/update_manager/raw/master/vcstudio/47.png)
**Congradulations!**
# Source Code # 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.*
### Files
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](../../run.py) Main file that operates the rest of the guts. - [run.py](../../run.py) Main file that operates the rest of the guts.
@ -90,7 +101,7 @@ Well at first. VCStudio is unsure of what language to use for the rest of the ch
**How do we know that there is no language yet set up?** **How do we know that there is no language yet set up?**
Basically on every startup it tries to make a system notification. Something like `:) I'm Happy To See You` which is reading the [language packs](https://notabug.org/jyamihud/VCStudio/src/master/settings/languages) using [talk.text()](https://notabug.org/jyamihud/VCStudio/src/master/settings/talk.py) function. Of course if in the settings file there is no setting for Language it will fail. And so if any fail accurs the [troubleshooter](https://notabug.org/jyamihud/VCStudio/src/master/troubleshooter/troubleshooter.py) is called. In the [settings file](../../settings/settings.data) there is a variable for `Language`. If it's not there. Or set to `False`. I will fail the initial test. And run the [troubleshooter](../../troubleshooter/troubleshooter.py) .
**What the troubleshooter does?** **What the troubleshooter does?**
@ -105,4 +116,4 @@ We can break the troubleshooter activity into 4 parts.
**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](../../project_manager/pm_gtk.py). Well the second time the [talk.text()](../../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).