Readme refactor (#35)
* Shorten the README.md file * Added more information and guides * Typo fix * Rename sections
This commit is contained in:
31
docs/COMPILE_FROM_SOURCE.md
Normal file
31
docs/COMPILE_FROM_SOURCE.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Compiling from source code
|
||||
## Requirements
|
||||
### Python 3 Interpreter
|
||||
Latest* version of **Python 3** is needed. Download the matching release for your platform [here](https://www.python.org/downloads/) and install it. If you are a *Windows* user, selecting **Add Python 3 to PATH** option is mandatory.
|
||||
|
||||
\* *Use Python 3.6.5 if you encounter an issue*
|
||||
## Using terminal
|
||||
### To open it...
|
||||
- On Windows 8/8.1/10: Press the File tab on **Windows Explorer**, click on **Open Windows PowerShell** or **Open Windows Command Prompt** or look for *Command Prompt* or *PowerShell* in *Start Menu*.
|
||||
|
||||
- On Windows 7: Press **WindowsKey+R**, type **cmd** and hit Enter or look for *Command Prompt* or *PowerShell* in *Start Menu*.
|
||||
|
||||
- On Linux: Press **Ctrl+Alt+T** or look for **Terminal** in the programs.
|
||||
|
||||
- On MacOS: Look for an app called **Terminal**.
|
||||
|
||||
### Navigating to the directory where script is downloaded
|
||||
Go inside the folder where script.py is located. If you are not familier with changing directories on command-prompt and terminal read *Changing Directories* in [this article](https://lifehacker.com/5633909/who-needs-a-mouse-learn-to-use-the-command-line-for-almost-anything)
|
||||
|
||||
## Finding the correct prefix for Python
|
||||
Enter these lines to terminal windows until it prints out the version you have downloaded and installed:
|
||||
- `python --version`
|
||||
- `python3 --version`
|
||||
- `python3.7 --version`
|
||||
- `python3.6 --version`
|
||||
- `py --version`
|
||||
- `py -3 --version`
|
||||
- `py -3.6 --version`
|
||||
- `py -3.7 --version`
|
||||
|
||||
Once you find it, use it at [Using command-line arguments](COMMAND_LINE_ARGUMENTS.md)
|
||||
Reference in New Issue
Block a user