diff --git a/docs/guides/dev-setup/dev-windows.md b/docs/guides/dev-setup/dev-windows.md new file mode 100644 index 0000000..516cd1e --- /dev/null +++ b/docs/guides/dev-setup/dev-windows.md @@ -0,0 +1,369 @@ +# Local Development Setup - Windows + +## Overview + +- **This guide assumes you are on Windows.** [Mac](dev-setup/mac.md) and [Linux](dev-setup/linux.md) have different methods. +- **Please read every step of this guide carefully.** It is highly recommend doing a full read-through before you even get started. + +Within this guide, we will be installing the following software: + +- [Composer](https://getcomposer.org) for handling PHP packages +- [VS Code](https://code.visualstudio.com) as our code editor + +!!! info "Windows Firewall Pop-ups" + At any point in time while installing the below software, you may see a pop-up like this. **Click "Allow" to allow the software to finish installing.** All of the recommended software is safe. + +
+ ![Windows Firewall pop-up](../../images/software-setup/windows/xampp-firewall.png){ width="600" } +
+ +## Copying Lorekeeper + +We are now going to use SourceGit to make a copy of Lorekeeper. This will be your personalized version that is posted to your live website. + +1. In SourceGit, select the little cloud icon in the top right to "Clone Repository." "Clone" is the Git term for making a copy of the code. + +
+ ![clicking clone repository button in sourcegit](../../images/dev-setup/windows/cloning-lk-1.png){ width="600" } +
+ +2. Now we will fill out this field with some information that tells SourceGit where the Lorekeeper code is located. In the browser, it can be accessed [here](https://github.com/lk-arpg/lorekeeper), but we use a slightly different URL address when pasting it into Git. + + - For **Repository URL**, paste in `https://github.com/lk-arpg/lorekeeper.git`. + - For **Parent Folder**, this will define where the code exists on our computer. If you installed XAMPP in the directory `C:/xampp/`, we will be selecting the folder `C:/xampp/htdocs`. **If this folder does not exist, create it.** + - Everything else can be left blank. + +3. Your window should look like this: + +
+ ![filling in the clone repository form](../../images/dev-setup/windows/cloning-lk-2.png){ width="600" } +
+ +4. Click "OK" to beginning cloning, and the process will begin. + +
+ ![repository cloning in progress](../../images/dev-setup/windows/cloning-lk-3.png){ width="600" } +
+ +5. You now have a copy of Lorekeeper on your computer! The first thing you will want to do is rename the origin (core Lorekeeper) remote. Click the dropdown for "Remotes", and then right click "origin" and click "Edit". + +
+ ![repository cloning in progress](../../images/dev-setup/windows/cloning-lk-4.png){ width="600" } +
+ +6. Rename this branch to "lorekeeper", or another similar identifier that will indicate to you that this is where LK updates will come from. + +
+ ![repository cloning in progress](../../images/dev-setup/windows/cloning-lk-5.png){ width="600" } +
+ +7. Click "OK" to save the change. It should now look like this: + +
+ ![repository cloning in progress](../../images/dev-setup/windows/cloning-lk-6.png){ width="600" } +
+ +!!! info "Cloning a Higher Version of LK" + + As of this writing, the main branch of LK is on version 2.1. You may wish to be on a higher version, such as the release branch version 3.0. + + **Please note that is *extremely discouraged* to put your site on the develop branch of Lorekeeper.** Please see our [dev intro](../dev-intro#navigating-branches) regarding different branches. + + SourceGit will clone the main branch by default. If you wish to update to version 3.0 or otherwise the current release, branch, simply pull that branch into your local branch with right click -> "Merge into main". + +
+ ![merging version 3 into main](../../images/dev-setup/windows/cloning-lk-higher-version.png){ width="600" } +
+ +## Setting Up Lorekeeper + +We need to install two more pieces of software before we can get our copy of Lorekeeper fully up and running. + +### Installing Composer + +1. First, we will install Composer, which handles installation of PHP packages. Go [here](https://getcomposer.org) and select "Download". + +
+ ![alt text](../../images/dev-setup/windows/composer-1.png){ width="600" } +
+ +2. Click the link for the Windows Installer, then run it. + +
+ ![alt text](../../images/dev-setup/windows/composer-2.png){ width="600" } +
+ +3. Click to install for all users. + +
+ ![alt text](../../images/dev-setup/windows/composer-3.png){ width="600" } +
+ +4. Leave developer mode **unchecked**. Click "Next". + +
+ ![alt text](../../images/dev-setup/windows/composer-4.png){ width="600" } +
+ +5. XAMPP should be automatically selected as your command line version of PHP. If not, use the dropdown to select it. If prompted, also select the checkmark to add it to your path. + +
+ ![alt text](../../images/dev-setup/windows/composer-5.png){ width="600" } +
+ +6. Click "Next" on this screen. + +
+ ![alt text](../../images/dev-setup/windows/composer-6.png){ width="600" } +
+ +7. You will see a screen similar to this one, summarizing your options. Click "Install". + +
+ ![alt text](../../images/dev-setup/windows/composer-7.png){ width="600" } +
+ +8. On this screen, click "Next". + +
+ ![alt text](../../images/dev-setup/windows/composer-8.png){ width="600" } +
+ +9. Then, click "Finish"! + +
+ ![alt text](../../images/dev-setup/windows/composer-9.png){ width="600" } +
+ +10. **Reboot your computer.** While Composer mentions that it won't always be necessary, rebooting our computer after installing Composer is the best way to prevent issues. + +### Installing Visual Studio Code + +Visual Studio Code is the code editor we will use to edit our Lorekeeper files. + +!!! info "A Note for Advanced Users" + + You can install the VSCodium open source version, which comes with AI/Copilot features disabled by default, [here](https://github.com/VSCodium/vscodium/releases). However, you may run into issues with using certain extensions due to Microsoft's licensing. + +1. Go [here](https://code.visualstudio.com) to download it and press the big download button. (Fortunately, we can disable the recently added AI features.) + +
+ ![alt text](../../images/dev-setup/windows/vscode-1.png){ width="600" } +
+ +2. Run the newly downloaded file. You will be presented with the license agreement. Check the agree button, then click "Next". + +3. Check all the boxes (with desktop icon checked depending on your preference) and click "Next". + +
+ ![alt text](../../images/dev-setup/windows/vscode-2.png){ width="600" } +
+ +4. Click "Install". + +5. It will then install. Check the button to launch it, then click the "Finish" button when complete. + +
+ ![alt text](../../images/dev-setup/windows/vscode-3.png){ width="600" } +
+ +!!! info "Disabling AI Features" + Microsoft constantly changes how to disable AI features within Visual Studio Code. As a result, unfortunately we can not provide up-to-date instructions. Please use your favorite search engine to find the latest way to disable these features. + + The Lorekeeper community does **not** encourage, promote, or endorse usage of AI tools. + +## Running Lorekeeper + +1. Open up the File Explorer and navigate to where Lorekeeper is installed on your computer. This is likely to be `C:/xampp/htdocs/lorekeeper` if you've been following our guides. + +2. Right click anywhere in the empty space (make sure you don't have a file/directory selected!) and click "Open With Code". + +
+ ![alt text](../../images/dev-setup/windows/running-lk-2.png){ width="600" } +
+ +3. Behold! All of the files that make up your Lorekeeper. However, we need to install a few files before it will work properly. In the top bar, click "Terminal" and then "New Terminal". + +
+ ![alt text](../../images/dev-setup/windows/running-lk-3.png){ width="600" } +
+ +4. Type in `composer install`. A lot of text will go flying by as composer installs the various chunks of code required for LK to run. + +
+ ![alt text](../../images/dev-setup/windows/running-lk-4.png){ width="600" } +
+ +**It may get stuck for a while on `Generating optimized autoload files`. Be patient! It will finish eventually.** + +
+ ![alt text](../../images/dev-setup/windows/running-lk-5.png){ width="600" } +
+ +It should look like this when done: + +
+ ![alt text](../../images/dev-setup/windows/running-lk-6.png){ width="600" } +
+ +5. Next, we will create the .env file, which will define some variables that Lorekeeper needs to run. Right-click near the bottom of the file list and click "New File". Name this file `.env`. + +
+ ![alt text](../../images/dev-setup/windows/running-lk-7.png){ width="600" } +
+ +6. The file should open by default (if not, double click it to open it). You will see a screen like this: + +
+ ![alt text](../../images/dev-setup/windows/running-lk-8.png){ width="600" } +
+ +8. **We're going to paste a lot of text here!** Here is the contents to paste into this file: + +``` +APP_NAME=Lorekeeper +APP_ENV=local +APP_KEY= +APP_DEBUG=true +APP_URL=http://localhost + +CONTACT_ADDRESS= +DEVIANTART_ACCOUNT= + +LOG_CHANNEL=stack +DB_CONNECTION=mysql +DB_HOST=127.0.0.1 +DB_PORT=3306 +DB_DATABASE=lorekeeper +DB_USERNAME=root +DB_PASSWORD= + +BROADCAST_DRIVER=log +CACHE_DRIVER=file +QUEUE_CONNECTION=sync +SESSION_DRIVER=file +SESSION_LIFETIME=120 + +BROADCAST_DRIVER=log +CACHE_DRIVER=file +QUEUE_CONNECTION=sync +SESSION_DRIVER=file +SESSION_LIFETIME=120 + +REDIS_HOST=127.0.0.1 +REDIS_PASSWORD=null +REDIS_PORT=6379 + +MAIL_DRIVER=smtp +MAIL_HOST=smtp.mailtrap.io +MAIL_PORT=2525 +MAIL_USERNAME=null +MAIL_PASSWORD=null +MAIL_ENCRYPTION=null + +AWS_ACCESS_KEY_ID= +AWS_SECRET_ACCESS_KEY= +AWS_DEFAULT_REGION=us-east-1 +AWS_BUCKET= + +PUSHER_APP_ID= +PUSHER_APP_KEY= +PUSHER_APP_SECRET= +PUSHER_APP_CLUSTER=mt1 + +MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}" +MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}" +``` + +9. Save the file. Now, go back to the terminal. We are going to run a few setup commands. Type in `php artisan key:generate`. You will see something like this: + +
+ ![alt text](../../images/dev-setup/windows/running-lk-9.png){ width="600" } +
+ +10. Next, type in `php artisan migrate`. This will populate the database with all of the tables that Lorekeeper needs to function. You'll see a LOT of text start to fly by. It should look like this when completed: + +
+ ![alt text](../../images/dev-setup/windows/running-lk-10.png){ width="600" } +
+ +!!! info "Adding MySQL to your PATH Variable" + + If you run into an error when running `php artisan migrate`, you may need to add MySQL to your computer's PATH variable. + + 1. Open your start menu and search for "edit system environment variables". +
+ ![start menu with edit environment variables selected](../../images/dev-setup/windows/env-variables-1.png){ width="300" } +
+ + 2. Click "Environment Variables" in the pop-up. + +
+ ![start menu with edit environment variables selected](../../images/dev-setup/windows/env-variables-2.png){ width="300" } +
+ + 3. Under "System Variables", selected "Path" and then "Edit..." + +
+ ![selecting path and then clicking edit on system variables](../../images/dev-setup/windows/env-variables-3.png){ width="300" } +
+ + 4. Click "New". + +
+ ![selecting new on environment variables window](../../images/dev-setup/windows/env-variables-4.png){ width="300" } +
+ + 5. Type in the location of your MySQL bin folder. For example, if you followed our XAMPP guide, this will be located `C:\xampp\mysql\bin`. Click OK to save. + +
+ ![entering mysql path into environment variables window](../../images/dev-setup/windows/env-variables-5.png){ width="300" } +
+ + 6. Restart Visual Studio Code as well as any other command prompts you have open for the changes to reflect. + +11. Now for some Lorekeeper-specific commands. Run `php artisan add-site-settings` to populate the database with the site settings. It should look like this when completed: + +
+ ![alt text](../../images/dev-setup/windows/running-lk-12.png){ width="600" } +
+ +12. Then run `php artisan add-text-pages`. This will add the default text pages for LK: + +
+ ![alt text](../../images/dev-setup/windows/running-lk-11.png){ width="600" } +
+ +13. Next run `php artisan copy-default-images`. This will add the default images for various features on LK: + +
+ ![alt text](../../images/dev-setup/windows/running-lk-16.png){ width="600" } +
+ +14. Finally, we will run the command `php artisan setup-admin-user`. This will create user #1, the default admin account. The email and details you give it do not need to be real, but make them something you'll remember easily. + +- `Proceed to create account with this information? (yes/no)` Answer **yes**. +- `Are you on a local/testing instance and not a live site? (yes/no)` Answer **yes**. +- `Would you like to mark your email address as verified and enter an alias now? (yes/no)` Answer **yes**. + +The important details to mark as `yes` have been highlighted in red. + +
+ ![alt text](../../images/dev-setup/windows/running-lk-13.png){ width="600" } +
+ +15. Now, go to `http://localhost` in your browser. You can also access this by pressing the "Admin" button next to "Apache" in XAMPP. + +
+ ![alt text](../../images/dev-setup/windows/running-lk-15.png){ width="600" } +
+ +## Setup Complete + +You have finished installing a local copy of Lorekeeper. You can login as the admin account you just set up, and begin trying out the different features. + +
+ ![alt text](../../images/dev-setup/windows/running-lk-14.png){ width="600" } +
+ +When you are ready, you can move onto [configuration or setting up a live website](../setup-index.md). \ No newline at end of file diff --git a/docs/guides/setup-index.md b/docs/guides/setup-index.md index f0eea6a..62177fa 100644 --- a/docs/guides/setup-index.md +++ b/docs/guides/setup-index.md @@ -10,28 +10,35 @@ There are several components to Lorekeeper setup, so installation information is The information here makes an effort to assume no technical background on the part of the reader. Consequently, some of the steps in this index recommend action for readers with existing technical background, depending on the nature thereof. If the latter applies to you, it's recommended you read the [developer introduction](dev-intro.md), as Lorekeeper and its ecosystem are somewhat unusual. -## Local Set-up +## Local Environment Set-up -This section concerns setting up the tools-- software-- that you will need to work with Lorekeeper, and obtaining a copy of the code. As the recommended tools depend heavily on which platform (or operating system) you are working on, information is provided for several platforms. +### Software Set-up + +This section concerns setting up the tools-- software-- that you will need to work with Lorekeeper. As the recommended tools depend heavily on which platform (or operating system) you are working on, information is provided for several platforms. Topics covered: +- Setting up your local webserver software (XAMPP, Laragon, Valet) - Working with git, setting up a graphical git client -- Setting up to connect to a remote server using SSH -!!! example "WIP" +Local setup on: - Currently, these links all lead to different sections of one page, under the assumption that the whole page will not end up too long (as it should only cover basic setup of tools). This may or may not end up being correct. +- [Windows](software-setup/software-windows.md) +- [Mac](software-setup/software-mac.md) +- [Linux](software-setup/software-linux.md) -Local setup on: +If the above main guides do not work for you (for example, if you run into issues with XAMPP), here are alternative guides: + +!!! example "WIP" -- [Windows](local-setup.md#windows) -- [Mac](local-setup.md#mac) -- [Linux](local-setup.md#linux) + Please suggest alternatives for other operating systems. -If you are already familiar with these subjects and have a preferred workflow, clone `https://github.com/lk-arpg/lorekeeper.git` via your preferred method and move on to the next step. +- [Windows - Laragon](software-setup/windows-laragon.md) +- [Windows - Valet](software-setup/windows-valet.md) + +If you already have a preferred workflow for locally serving and developing PHP-based applications, move onto the next step. -### Setting up a Local Development Environment +### Development Environment Set-up Before moving ahead to setting up a live Lorekeeper site, it's recommended to set up a local or development environment so that you can preview and test your changes as you make them-- and *before* pushing them to a live site. This helps catch errors (especially large or breaking ones!) before they become larger problems, and is especially key if you plan to (or have already) modified your Lorekeeper site heavily! @@ -41,23 +48,23 @@ As above, this process is heavily dependent on your local platform, and is broke Topics covered: -- Setting up PHP, MySQL (or MariaDB), and a webserver on your local machine +- Cloning a copy of Lorekeeper - Installing composer locally -- Serving your local files and working with them locally +- Serving your local files and working with them !!! example "WIP" - As development environment setup is liable to be more involved than basic setup of tools-- and may offer multiple options, e.g. for serving site files locally on Windows-- these currently link to separate pages. + As development environment setup is liable to be more involved than basic setup of tools, these currently link to separate pages. Development environment setup on: -- [Windows](dev-setup-win.md) -- [Mac](dev-setup-mac.md) -- [Linux](dev-setup-linux.md) +- [Windows](dev-setup/dev-windows.md) +- [Mac](dev-setup/dev-mac.md) +- [Linux](dev-setup/dev-linux.md) -If you already have a preferred workflow for developing PHP-based applications, do so for the local files you set up in the previous step and move on to the next one. +If you are already familiar with these subjects and have a preferred workflow, clone `https://github.com/lk-arpg/lorekeeper.git` via your preferred method and move on to the next step. -## Webserver Set-up +## Webserver (Live) Set-up This section concerns setting up a webserver to host your Lorekeeper site so that it is accessible via the internet at large. The steps involved here are generally *host* rather than platform-specific, as in most cases you will be working with some form of Linux server. @@ -71,6 +78,8 @@ Topics covered: - Selecting hosting - Setting up on a given host +For any of the below guides, you will first need to [set up a SSH client](software-setup/ssh-clients.md). + !!! example "WIP" Both the DigitalOcean and Hetzner guides are ultimately going to boil down to a "bare-bones VPS setup" guide, so it's likely worth writing that as its own guide and linking to it from them. diff --git a/docs/guides/software-setup/software-windows.md b/docs/guides/software-setup/software-windows.md new file mode 100644 index 0000000..0627080 --- /dev/null +++ b/docs/guides/software-setup/software-windows.md @@ -0,0 +1,355 @@ +# Local Software Setup - Windows + +## Overview + +- **This guide assumes you are on Windows.** [Mac](software-setup/mac.md) and [Linux](software-setup/linux.md) have different methods. +- **Please read every step of this guide carefully.** It is highly recommend doing a full read-through before you even get started. + +Within this guide, we will be installing the following software: + +- [XAMPP](https://www.apachefriends.org/download.html) for the local webserver and database +- [SourceGit](https://sourcegit-scm.github.io) for our graphical git client + +!!! info "Windows Firewall Pop-ups" + At any point in time while installing the below software, you may see a pop-up like this. **Click "Allow" to allow the software to finish installing.** All of the recommended software is safe. + +
+ ![Windows Firewall pop-up](../../images/software-setup/windows/xampp-firewall.png){ width="600" } +
+ +## XAMPP Setup + +### Installing XAMPP + +1. Download [XAMPP](https://www.apachefriends.org/download.html). + + - For LK v2, select **PHP 8.1**. + - For LK v3.0 or above, select **PHP 8.2**. + +
+ ![Downloading XAMPP](../../images/software-setup/windows/setup-xampp.png){ width="600" } +
+ +2. Run the XAMPP .exe file. **If you see this warning, as long as you follow this guide, you can ignore it and just hit "OK".** + +
+ ![XAMPP UAC Error](../../images/software-setup/windows/xampp-error.png){ width="600" } +
+ +3. Click the "Next" button. You will then see this screen. We just want the defaults -- click "Next" again. + +
+ ![XAMPP Installation Default Settings](../../images/software-setup/windows/xampp-defaults.png){ width="600" } +
+ +4. Install XAMPP directly onto your C: drive. A good location is `C:\xampp`, which should also be the default. Then, click "Next". + +
+ ![XAMPP Installation Directory](../../images/software-setup/windows/xampp-directory.png){ width="600" } +
+ +5. Select your preferred language. This doesn't matter -- pick what's best for you. + +
+ ![XAMPP Installation Language](../../images/software-setup/windows/xampp-language.png){ width="600" } +
+ +6. Click "Next" on the following screen. + +
+ ![XAMPP Installation Ready to Install Screen](../../images/software-setup/windows/xampp-ready-to-install.png){ width="600" } +
+ +7. XAMPP should now begin to install. This may take some time -- be patient! + +
+ ![XAMPP Installating](../../images/software-setup/windows/xampp-installing.png){ width="600" } +
+ +8. Once XAMPP has installed, check the box to start the control panel immediately (if it is not checked by default) and click "Finish". + +
+ ![XAMPP Installation Finished](../../images/software-setup/windows/xampp-finished.png){ width="600" } +
+ +9. Congrats! You now have XAMPP installed. Click "Start" next to Apache and MySQL. + +
+ ![Starting Apache and MySQL](../../images/software-setup/windows/xampp-start.png){ width="600" } +
+ +!!! info "Windows Defender Firewall Alert" + If you are presented with a window like this for either application: Check both "Private" and "Public", then click "Allow Access". + + This software is safe. You may need to click "Show More" to see these options. + +
+ ![Starting Apache and MySQL](../../images/software-setup/windows/uac-error.png){ width="600" } +
+ +### Configuring XAMPP + +1. Next, we need to update the config files. Click "Config" next to Apache, and select `php.ini`. + +
+ ![Opening the PHP.ini in XAMPP](../../images/software-setup/windows/xampp-php-ini.png){ width="600" } +
+ +2. A file should open up in Notepad. We are going to change two values. First, use the search feature (Ctrl + F) or simply scroll down until you see `post_max_size`. This controls how large the files are that you can upload. Change this to a number similar to what you'll use on your live website. If you don't know yet, change it to `5M` (five megabytes). + +
+ ![Editing the post_max_size variable](../../images/software-setup/windows/xampp-post-max.png){ width="600" } +
+ +![alt text](image.png) + +3. The next value we change is `upload_max_filesize`. I like to change this to abnormally high on my local, but make it whatever feels right for you. To change it to 10 megabytes, for example, put a value of `10M`. + +
+ ![Editing the upload_max_size variable](../../images/software-setup/windows/xampp-upload-max.png){ width="600" } +
+ +4. Save your changes and close this file. We are going to edit one more config file. + +5. Go back to XAMPP, click "Config", and select `httpd.conf`. + +
+ ![Selecting the http.conf file](../../images/software-setup/windows/xampp-http-conf.png){ width="600" } +
+ +6. Another file should open up in Notepad. We are going to change one value this time. Change whatever value is currently in `DocumentRoot` and the following `Directory` line to `C:/xampp/htdocs/lorekeeper/public`. + +
+ ![Updating the DocumentRoot value](../../images/software-setup/windows/xampp-document-root.png){ width="600" } +
+ +7. Save your changes and close this file. Then, click the "Stop" button next to Apache. After it **fully shuts downs**, click "Start" again. + +
+ ![Stopping and starting XAMPP](../../images/software-setup/windows/xampp-stop-start.png){ width="600" } +
+ +!!! info + Apache may fail to start if the folder `C:/xampp/htdocs/lorekeeper/public` does not exist. **This is OK.** Continue with this guide, and Apache will start after you have cloned LK. + +8. Next, we are going to make one more change in anticipation of installing Lorekeeper. Click the "Admin" button next to MySQL. + +
+ ![pressing the mysql admin button](../../images/software-setup/windows/mysql-admin.png){ width="600" } +
+ +9. This will open a window similar to this in your browser. This is PHPMyAdmin, and it is where we control how most of the data is stored for Lorekeeper. Click "New". + +
+ ![phpmyadmin front page](../../images/software-setup/windows/phpmyadmin-start.png){ width="600" } +
+ +10. Type in `lorekeeper` or any other easy to remember name, then click "Create". + +
+ ![creating a database in phpmyadmin](../../images/software-setup/windows/phpmyadmin-create.png){ width="600" } +
+ +11. **Congratulations! We're done here for now.** Next, we will install the Git software needed to manage our Lorekeeper files. + +## Installing Git Software + +Historically, the software used for managing Git was Sourcetree, but I will be using **SourceGit** as it is more stable and frequently updated. + +### Installing Git + +1. First, we need to install Git itself. Git is a tool used to manage files and file history for coding projects. Go [here](https://git-scm.com/downloads) to download the latest copy of Git. + +Click this button... +
+ ![downloading git from the website](../../images/software-setup/windows/git-dl-1.png){ width="600" } +
+ +..and then this link. +
+ ![clicking the second download link for git](../../images/software-setup/windows/git-dl-2.png){ width="600" } +
+ +2. After the file is done downloading, run it. You will see this screen. Press "Next". + +
+ ![git gnu license agreement](../../images/software-setup/windows/git-install.png){ width="600" } +
+ +3. You may see a screen asking about a start menu folder. The default location (often "Git") is acceptable. Press "Next". + +4. **Make sure the highlighted fields are selected.** Press "Next". + +
+ ![a checklist of installation settings for git](../../images/software-setup/windows/git-install-1.png){ width="600" } +
+ +5. This next option is up to you. Notepad++ (if you have it installed) or Notepad are both valid options. + +
+ ![selecting your default text editor for git](../../images/software-setup/windows/git-install-2.png){ width="600" } +
+ +6. For maximum compatibility with Lorekeeper, you will want to make sure you check "Override" and type in `main`. + +
+ ![selecting your default branch name for git](../../images/software-setup/windows/git-install-3.png){ width="600" } +
+ +7. You will then see this screen. Select the middle/"recommended" option. + +
+ ![command line installation options for git](../../images/software-setup/windows/git-install-4.png){ width="600" } +
+ +8. Select "OpenSSH". + +
+ ![selecting default ssh option for git](../../images/software-setup/windows/git-install-5.png){ width="600" } +
+ +9. Leave this option as whatever your computer detects as default. + +
+ ![selecting how to handle SSL connections for git](../../images/software-setup/windows/git-install-6.png){ width="600" } +
+ +10. Select "Checkout Windows-style, commit Unix-style line endings". + +
+ ![selecting line ending conversion settings for git](../../images/software-setup/windows/git-install-7.png){ width="600" } +
+ +11. Select "MinTTY". + +
+ ![selecting the terminal editor for git](../../images/software-setup/windows/git-install-8.png){ width="600" } +
+ +12. **This one is important. Select "fast-forward or merge".** + +
+ ![selecting the terminal editor for git](../../images/software-setup/windows/git-install-9.png){ width="600" } +
+ +13. Select "Git Credential Manager". + +
+ ![alt text](../../images/software-setup/windows/git-install-10.png){ width="600" } +
+ +14. Enable both file-system caching and symbolic links. + +
+ ![alt text](../../images/software-setup/windows/git-install-11.png){ width="600" } +
+ +15. You may be prompted with this screen. If so, **close all other windows on your computer** and then click "Install". + +
+ ![alt text](../../images/software-setup/windows/git-install-12.png){ width="600" } +
+ +16. Git will then begin to install. Be patient while it completes! + +
+ ![alt text](../../images/software-setup/windows/git-install-13.png){ width="600" } +
+ +17. Congratulations! Git is now installed. Check "finish". + +
+ ![alt text](../../images/software-setup/windows/git-install-14.png){ width="600" } +
+ +18. **Reboot your entire computer.** Certain things we installed with Git will only take effect _after_ our computer has restarted. So do that, and then come back! + +### Installing SourceGit + +You can use Git purely from the command line, but it's not reccomended for beginners. To make things easier, we will be using a tool called **SourceGit**. + +1. Go to [SourceGit's website](https://sourcegit-scm.github.io) and click the download button in the top right. + +
+ ![alt text](../../images/software-setup/windows/installing-sourcegit.png){ width="600" } +
+ +2. Scroll down to the list of files. You want the version ending with **win-x64.zip**. + +
+ ![alt text](../../images/software-setup/windows/installing-sourcegit-filelist.png){ width="600" } +
+ +3. Open your Downloads folder (or wherever you downloaded this file) in File Explorer. Right click the file and select "Extract all." + +
+ ![alt text](../../images/software-setup/windows/installing-sourcegit-file-extract.png){ width="600" } +
+ +4. Extract this file somewhere easy to remember, such as `C:/sourcegit`. + +
+ ![alt text](../../images/software-setup/windows/installing-sourcegit-file-extract-2.png){ width="600" } +
+ +4. Navigate to this folder in your File Explorer. It will contain a folder named "SourceGit". Open that folder. + +
+ ![alt text](../../images/software-setup/windows/installing-sourcegit-file-folder.png){ width="600" } +
+ +5. Run the file **SourceGit.exe**. + +
+ ![alt text](../../images/software-setup/windows/installing-sourcegit-file-exe.png){ width="600" } +
+ +!!! info "SmartScreen Warning" + You may receive a popup from Windows warning you about the file. **This file is safe.** + + Click "More Info": +
+ ![clicking more info on the smartscreen popup](../../images/software-setup/windows/installing-sourcegit-smartscreen-1.png){ width="600" } +
+ + And then "Run Anyway" to start SourceGit: +
+ ![click run anyway on the smartscreen popup](../../images/software-setup/windows/installing-sourcegit-smartscreen-2.png){ width="600" } +
+ +6. You should be presented with a relatively blank page: + +
+ ![alt text](../../images/software-setup/windows/configuring-sourcegit-1.png){ width="600" } +
+ +7. There's one final thing we need to configure, and that is the username and email that Git will use. Click the three bars in the top right, and then click "Preferences". + +
+ ![alt text](../../images/software-setup/windows/configuring-sourcegit-2.png){ width="600" } +
+ +8. Click on the "Git" tab. + +
+ ![alt text](../../images/software-setup/windows/configuring-sourcegit-3.png){ width="600" } +
+ +9. In the User Name and User Email fields, **put in information that is accurate, but you are OK with potentially being made public to anyone who works on your code.** + +
+ ![alt text](../../images/software-setup/windows/configuring-sourcegit-4.png){ width="600" } +
+ +!!! info "Customizing Appearance" + If you want, you can also swap to Dark Mode from the "Appearance" tab. + +
+ ![alt text](../../images/software-setup/windows/configuring-sourcegit-5.png){ width="600" } +
+ +10. Close the Preferences window, and it will save automatically. + +## Setup Complete + +You have installed a local webserver and the software needed to handling Lorekeeper's code. You can now move onto [setting up your local copy of Lorekeeper](../setup-index.md#development-environment-set-up). \ No newline at end of file diff --git a/docs/guides/software-setup/ssh-clients.md b/docs/guides/software-setup/ssh-clients.md new file mode 100644 index 0000000..a6c784e --- /dev/null +++ b/docs/guides/software-setup/ssh-clients.md @@ -0,0 +1,59 @@ +# SSH Client Setup + +!!! example "WIP" + + Please include information here for Mac and Linux. + +SSH (Secure Shell Protocol) is used to securely connect from your local computer to a remote server. It is required to interact with your live version of Lorekeeper. + +## Windows + +For Windows, the preferred SSH client is PuTTY. + +1. Go [here](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) to download PuTTY. Click the highlighted link to download it -- for most cases, you want the "64-bit x86" version. + +
+ ![alt text](../../images/software-setup/ssh-clients/setting-up-ssh.png){ width="600" } +
+ +2. We're going to click through the screens to install PuTTY. Click "Next", leaving all settings as default, until you reach the "Install" button. + +
+ ![alt text](../../images/software-setup/ssh-clients/setting-up-ssh-1.png){ width="600" } +
+ +3. After that's done, feel free to uncheck the README, and click "Finish". + +
+ ![alt text](../../images/software-setup/ssh-clients/setting-up-ssh-2.png){ width="600" } +
+ +4. When you installed PuTTY, it also installs a software called PuTTYgen. Open up this software. + +
+ ![alt text](../../images/software-setup/ssh-clients/setting-up-ssh-3.png){ width="600" } +
+ +5. It should look like this when opened. We are going to press the "Generate" button. + +
+ ![alt text](../../images/software-setup/ssh-clients/setting-up-ssh-4.png){ width="600" } +
+ +6. Wiggle your mouse around as instructed! + +
+ ![alt text](../../images/software-setup/ssh-clients/setting-up-ssh-5.png){ width="600" } +
+ +7. Save both your Public and Private key to somewhere safe on your computer. **The key is shown in this image for example's sake, but do not share your key publicly!** It's better to have people set up their own keys than to share yours. + +
+ ![alt text](../../images/software-setup/ssh-clients/setting-up-ssh-6.png){ width="600" } +
+ +You will use these keys when [configuring your live server](../setup-index.md#webserver-live-set-up). + +## Mac + +## Linux \ No newline at end of file diff --git a/docs/images/dev-setup/windows/cloning-lk-1.png b/docs/images/dev-setup/windows/cloning-lk-1.png new file mode 100644 index 0000000..52269a3 Binary files /dev/null and b/docs/images/dev-setup/windows/cloning-lk-1.png differ diff --git a/docs/images/dev-setup/windows/cloning-lk-2.png b/docs/images/dev-setup/windows/cloning-lk-2.png new file mode 100644 index 0000000..2676c4e Binary files /dev/null and b/docs/images/dev-setup/windows/cloning-lk-2.png differ diff --git a/docs/images/dev-setup/windows/cloning-lk-3.png b/docs/images/dev-setup/windows/cloning-lk-3.png new file mode 100644 index 0000000..670b5fe Binary files /dev/null and b/docs/images/dev-setup/windows/cloning-lk-3.png differ diff --git a/docs/images/dev-setup/windows/cloning-lk-4.png b/docs/images/dev-setup/windows/cloning-lk-4.png new file mode 100644 index 0000000..6cd668b Binary files /dev/null and b/docs/images/dev-setup/windows/cloning-lk-4.png differ diff --git a/docs/images/dev-setup/windows/cloning-lk-5.png b/docs/images/dev-setup/windows/cloning-lk-5.png new file mode 100644 index 0000000..08ffd46 Binary files /dev/null and b/docs/images/dev-setup/windows/cloning-lk-5.png differ diff --git a/docs/images/dev-setup/windows/cloning-lk-6.png b/docs/images/dev-setup/windows/cloning-lk-6.png new file mode 100644 index 0000000..8aca9c9 Binary files /dev/null and b/docs/images/dev-setup/windows/cloning-lk-6.png differ diff --git a/docs/images/dev-setup/windows/cloning-lk-higher-version.png b/docs/images/dev-setup/windows/cloning-lk-higher-version.png new file mode 100644 index 0000000..01f0cae Binary files /dev/null and b/docs/images/dev-setup/windows/cloning-lk-higher-version.png differ diff --git a/docs/images/dev-setup/windows/composer-1.png b/docs/images/dev-setup/windows/composer-1.png new file mode 100644 index 0000000..b0324a4 Binary files /dev/null and b/docs/images/dev-setup/windows/composer-1.png differ diff --git a/docs/images/dev-setup/windows/composer-2.png b/docs/images/dev-setup/windows/composer-2.png new file mode 100644 index 0000000..eb80faf Binary files /dev/null and b/docs/images/dev-setup/windows/composer-2.png differ diff --git a/docs/images/dev-setup/windows/composer-3.png b/docs/images/dev-setup/windows/composer-3.png new file mode 100644 index 0000000..9528cab Binary files /dev/null and b/docs/images/dev-setup/windows/composer-3.png differ diff --git a/docs/images/dev-setup/windows/composer-4.png b/docs/images/dev-setup/windows/composer-4.png new file mode 100644 index 0000000..0bec1f8 Binary files /dev/null and b/docs/images/dev-setup/windows/composer-4.png differ diff --git a/docs/images/dev-setup/windows/composer-5.png b/docs/images/dev-setup/windows/composer-5.png new file mode 100644 index 0000000..571defb Binary files /dev/null and b/docs/images/dev-setup/windows/composer-5.png differ diff --git a/docs/images/dev-setup/windows/composer-6.png b/docs/images/dev-setup/windows/composer-6.png new file mode 100644 index 0000000..577a932 Binary files /dev/null and b/docs/images/dev-setup/windows/composer-6.png differ diff --git a/docs/images/dev-setup/windows/composer-7.png b/docs/images/dev-setup/windows/composer-7.png new file mode 100644 index 0000000..345f0e5 Binary files /dev/null and b/docs/images/dev-setup/windows/composer-7.png differ diff --git a/docs/images/dev-setup/windows/composer-8.png b/docs/images/dev-setup/windows/composer-8.png new file mode 100644 index 0000000..1962b3d Binary files /dev/null and b/docs/images/dev-setup/windows/composer-8.png differ diff --git a/docs/images/dev-setup/windows/composer-9.png b/docs/images/dev-setup/windows/composer-9.png new file mode 100644 index 0000000..70e7b46 Binary files /dev/null and b/docs/images/dev-setup/windows/composer-9.png differ diff --git a/docs/images/dev-setup/windows/env-variables-1.png b/docs/images/dev-setup/windows/env-variables-1.png new file mode 100644 index 0000000..e4bb839 Binary files /dev/null and b/docs/images/dev-setup/windows/env-variables-1.png differ diff --git a/docs/images/dev-setup/windows/env-variables-2.png b/docs/images/dev-setup/windows/env-variables-2.png new file mode 100644 index 0000000..74a2b13 Binary files /dev/null and b/docs/images/dev-setup/windows/env-variables-2.png differ diff --git a/docs/images/dev-setup/windows/env-variables-3.png b/docs/images/dev-setup/windows/env-variables-3.png new file mode 100644 index 0000000..c0e59bc Binary files /dev/null and b/docs/images/dev-setup/windows/env-variables-3.png differ diff --git a/docs/images/dev-setup/windows/env-variables-4.png b/docs/images/dev-setup/windows/env-variables-4.png new file mode 100644 index 0000000..ce9770c Binary files /dev/null and b/docs/images/dev-setup/windows/env-variables-4.png differ diff --git a/docs/images/dev-setup/windows/env-variables-5.png b/docs/images/dev-setup/windows/env-variables-5.png new file mode 100644 index 0000000..126ba64 Binary files /dev/null and b/docs/images/dev-setup/windows/env-variables-5.png differ diff --git a/docs/images/dev-setup/windows/running-lk-1.png b/docs/images/dev-setup/windows/running-lk-1.png new file mode 100644 index 0000000..efaf23a Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-1.png differ diff --git a/docs/images/dev-setup/windows/running-lk-10.png b/docs/images/dev-setup/windows/running-lk-10.png new file mode 100644 index 0000000..c04e248 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-10.png differ diff --git a/docs/images/dev-setup/windows/running-lk-11.png b/docs/images/dev-setup/windows/running-lk-11.png new file mode 100644 index 0000000..2f0fd62 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-11.png differ diff --git a/docs/images/dev-setup/windows/running-lk-12.png b/docs/images/dev-setup/windows/running-lk-12.png new file mode 100644 index 0000000..276cd02 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-12.png differ diff --git a/docs/images/dev-setup/windows/running-lk-13.png b/docs/images/dev-setup/windows/running-lk-13.png new file mode 100644 index 0000000..4d6f114 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-13.png differ diff --git a/docs/images/dev-setup/windows/running-lk-14.png b/docs/images/dev-setup/windows/running-lk-14.png new file mode 100644 index 0000000..fd61d9b Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-14.png differ diff --git a/docs/images/dev-setup/windows/running-lk-15.png b/docs/images/dev-setup/windows/running-lk-15.png new file mode 100644 index 0000000..b203d30 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-15.png differ diff --git a/docs/images/dev-setup/windows/running-lk-16.png b/docs/images/dev-setup/windows/running-lk-16.png new file mode 100644 index 0000000..8e37e06 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-16.png differ diff --git a/docs/images/dev-setup/windows/running-lk-2.png b/docs/images/dev-setup/windows/running-lk-2.png new file mode 100644 index 0000000..4da0806 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-2.png differ diff --git a/docs/images/dev-setup/windows/running-lk-3.png b/docs/images/dev-setup/windows/running-lk-3.png new file mode 100644 index 0000000..f797107 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-3.png differ diff --git a/docs/images/dev-setup/windows/running-lk-4.png b/docs/images/dev-setup/windows/running-lk-4.png new file mode 100644 index 0000000..de3b87f Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-4.png differ diff --git a/docs/images/dev-setup/windows/running-lk-5.png b/docs/images/dev-setup/windows/running-lk-5.png new file mode 100644 index 0000000..c77c9c0 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-5.png differ diff --git a/docs/images/dev-setup/windows/running-lk-6.png b/docs/images/dev-setup/windows/running-lk-6.png new file mode 100644 index 0000000..c46d9d9 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-6.png differ diff --git a/docs/images/dev-setup/windows/running-lk-7.png b/docs/images/dev-setup/windows/running-lk-7.png new file mode 100644 index 0000000..e4c9452 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-7.png differ diff --git a/docs/images/dev-setup/windows/running-lk-8.png b/docs/images/dev-setup/windows/running-lk-8.png new file mode 100644 index 0000000..bf474d1 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-8.png differ diff --git a/docs/images/dev-setup/windows/running-lk-9.png b/docs/images/dev-setup/windows/running-lk-9.png new file mode 100644 index 0000000..e6d0f60 Binary files /dev/null and b/docs/images/dev-setup/windows/running-lk-9.png differ diff --git a/docs/images/dev-setup/windows/vscode-1.png b/docs/images/dev-setup/windows/vscode-1.png new file mode 100644 index 0000000..e16d139 Binary files /dev/null and b/docs/images/dev-setup/windows/vscode-1.png differ diff --git a/docs/images/dev-setup/windows/vscode-2.png b/docs/images/dev-setup/windows/vscode-2.png new file mode 100644 index 0000000..8775395 Binary files /dev/null and b/docs/images/dev-setup/windows/vscode-2.png differ diff --git a/docs/images/dev-setup/windows/vscode-3.png b/docs/images/dev-setup/windows/vscode-3.png new file mode 100644 index 0000000..180b3fb Binary files /dev/null and b/docs/images/dev-setup/windows/vscode-3.png differ diff --git a/docs/images/software-setup/ssh-clients/setting-up-ssh-1.png b/docs/images/software-setup/ssh-clients/setting-up-ssh-1.png new file mode 100644 index 0000000..3151d74 Binary files /dev/null and b/docs/images/software-setup/ssh-clients/setting-up-ssh-1.png differ diff --git a/docs/images/software-setup/ssh-clients/setting-up-ssh-2.png b/docs/images/software-setup/ssh-clients/setting-up-ssh-2.png new file mode 100644 index 0000000..edb9af5 Binary files /dev/null and b/docs/images/software-setup/ssh-clients/setting-up-ssh-2.png differ diff --git a/docs/images/software-setup/ssh-clients/setting-up-ssh-3.png b/docs/images/software-setup/ssh-clients/setting-up-ssh-3.png new file mode 100644 index 0000000..b759147 Binary files /dev/null and b/docs/images/software-setup/ssh-clients/setting-up-ssh-3.png differ diff --git a/docs/images/software-setup/ssh-clients/setting-up-ssh-4.png b/docs/images/software-setup/ssh-clients/setting-up-ssh-4.png new file mode 100644 index 0000000..3eb3bee Binary files /dev/null and b/docs/images/software-setup/ssh-clients/setting-up-ssh-4.png differ diff --git a/docs/images/software-setup/ssh-clients/setting-up-ssh-5.png b/docs/images/software-setup/ssh-clients/setting-up-ssh-5.png new file mode 100644 index 0000000..93ffc59 Binary files /dev/null and b/docs/images/software-setup/ssh-clients/setting-up-ssh-5.png differ diff --git a/docs/images/software-setup/ssh-clients/setting-up-ssh-6.png b/docs/images/software-setup/ssh-clients/setting-up-ssh-6.png new file mode 100644 index 0000000..f6b8b28 Binary files /dev/null and b/docs/images/software-setup/ssh-clients/setting-up-ssh-6.png differ diff --git a/docs/images/software-setup/ssh-clients/setting-up-ssh.png b/docs/images/software-setup/ssh-clients/setting-up-ssh.png new file mode 100644 index 0000000..f1006dd Binary files /dev/null and b/docs/images/software-setup/ssh-clients/setting-up-ssh.png differ diff --git a/docs/images/software-setup/windows/configuring-sourcegit-1.png b/docs/images/software-setup/windows/configuring-sourcegit-1.png new file mode 100644 index 0000000..a069246 Binary files /dev/null and b/docs/images/software-setup/windows/configuring-sourcegit-1.png differ diff --git a/docs/images/software-setup/windows/configuring-sourcegit-2.png b/docs/images/software-setup/windows/configuring-sourcegit-2.png new file mode 100644 index 0000000..43e0a85 Binary files /dev/null and b/docs/images/software-setup/windows/configuring-sourcegit-2.png differ diff --git a/docs/images/software-setup/windows/configuring-sourcegit-3.png b/docs/images/software-setup/windows/configuring-sourcegit-3.png new file mode 100644 index 0000000..c4edccc Binary files /dev/null and b/docs/images/software-setup/windows/configuring-sourcegit-3.png differ diff --git a/docs/images/software-setup/windows/configuring-sourcegit-4.png b/docs/images/software-setup/windows/configuring-sourcegit-4.png new file mode 100644 index 0000000..e32ad89 Binary files /dev/null and b/docs/images/software-setup/windows/configuring-sourcegit-4.png differ diff --git a/docs/images/software-setup/windows/configuring-sourcegit-5.png b/docs/images/software-setup/windows/configuring-sourcegit-5.png new file mode 100644 index 0000000..377ff1d Binary files /dev/null and b/docs/images/software-setup/windows/configuring-sourcegit-5.png differ diff --git a/docs/images/software-setup/windows/git-dl-1.png b/docs/images/software-setup/windows/git-dl-1.png new file mode 100644 index 0000000..cceaa4a Binary files /dev/null and b/docs/images/software-setup/windows/git-dl-1.png differ diff --git a/docs/images/software-setup/windows/git-dl-2.png b/docs/images/software-setup/windows/git-dl-2.png new file mode 100644 index 0000000..d94ca74 Binary files /dev/null and b/docs/images/software-setup/windows/git-dl-2.png differ diff --git a/docs/images/software-setup/windows/git-install-1.png b/docs/images/software-setup/windows/git-install-1.png new file mode 100644 index 0000000..adffd07 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-1.png differ diff --git a/docs/images/software-setup/windows/git-install-10.png b/docs/images/software-setup/windows/git-install-10.png new file mode 100644 index 0000000..403ff12 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-10.png differ diff --git a/docs/images/software-setup/windows/git-install-11.png b/docs/images/software-setup/windows/git-install-11.png new file mode 100644 index 0000000..64525e8 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-11.png differ diff --git a/docs/images/software-setup/windows/git-install-12.png b/docs/images/software-setup/windows/git-install-12.png new file mode 100644 index 0000000..0b9f760 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-12.png differ diff --git a/docs/images/software-setup/windows/git-install-13.png b/docs/images/software-setup/windows/git-install-13.png new file mode 100644 index 0000000..124fea7 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-13.png differ diff --git a/docs/images/software-setup/windows/git-install-14.png b/docs/images/software-setup/windows/git-install-14.png new file mode 100644 index 0000000..b61fef5 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-14.png differ diff --git a/docs/images/software-setup/windows/git-install-2.png b/docs/images/software-setup/windows/git-install-2.png new file mode 100644 index 0000000..7651dcb Binary files /dev/null and b/docs/images/software-setup/windows/git-install-2.png differ diff --git a/docs/images/software-setup/windows/git-install-3.png b/docs/images/software-setup/windows/git-install-3.png new file mode 100644 index 0000000..a6e7e99 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-3.png differ diff --git a/docs/images/software-setup/windows/git-install-4.png b/docs/images/software-setup/windows/git-install-4.png new file mode 100644 index 0000000..f8f8eb8 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-4.png differ diff --git a/docs/images/software-setup/windows/git-install-5.png b/docs/images/software-setup/windows/git-install-5.png new file mode 100644 index 0000000..39e8639 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-5.png differ diff --git a/docs/images/software-setup/windows/git-install-6.png b/docs/images/software-setup/windows/git-install-6.png new file mode 100644 index 0000000..431e4c4 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-6.png differ diff --git a/docs/images/software-setup/windows/git-install-7.png b/docs/images/software-setup/windows/git-install-7.png new file mode 100644 index 0000000..764080e Binary files /dev/null and b/docs/images/software-setup/windows/git-install-7.png differ diff --git a/docs/images/software-setup/windows/git-install-8.png b/docs/images/software-setup/windows/git-install-8.png new file mode 100644 index 0000000..35f3a20 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-8.png differ diff --git a/docs/images/software-setup/windows/git-install-9.png b/docs/images/software-setup/windows/git-install-9.png new file mode 100644 index 0000000..9344068 Binary files /dev/null and b/docs/images/software-setup/windows/git-install-9.png differ diff --git a/docs/images/software-setup/windows/git-install.png b/docs/images/software-setup/windows/git-install.png new file mode 100644 index 0000000..58cb324 Binary files /dev/null and b/docs/images/software-setup/windows/git-install.png differ diff --git a/docs/images/software-setup/windows/installing-sourcegit-file-exe.png b/docs/images/software-setup/windows/installing-sourcegit-file-exe.png new file mode 100644 index 0000000..078b67f Binary files /dev/null and b/docs/images/software-setup/windows/installing-sourcegit-file-exe.png differ diff --git a/docs/images/software-setup/windows/installing-sourcegit-file-extract-2.png b/docs/images/software-setup/windows/installing-sourcegit-file-extract-2.png new file mode 100644 index 0000000..902020b Binary files /dev/null and b/docs/images/software-setup/windows/installing-sourcegit-file-extract-2.png differ diff --git a/docs/images/software-setup/windows/installing-sourcegit-file-extract.png b/docs/images/software-setup/windows/installing-sourcegit-file-extract.png new file mode 100644 index 0000000..2efa184 Binary files /dev/null and b/docs/images/software-setup/windows/installing-sourcegit-file-extract.png differ diff --git a/docs/images/software-setup/windows/installing-sourcegit-file-folder.png b/docs/images/software-setup/windows/installing-sourcegit-file-folder.png new file mode 100644 index 0000000..6395d4a Binary files /dev/null and b/docs/images/software-setup/windows/installing-sourcegit-file-folder.png differ diff --git a/docs/images/software-setup/windows/installing-sourcegit-filelist.png b/docs/images/software-setup/windows/installing-sourcegit-filelist.png new file mode 100644 index 0000000..46f14f2 Binary files /dev/null and b/docs/images/software-setup/windows/installing-sourcegit-filelist.png differ diff --git a/docs/images/software-setup/windows/installing-sourcegit-smartscreen-1.png b/docs/images/software-setup/windows/installing-sourcegit-smartscreen-1.png new file mode 100644 index 0000000..5ba43a9 Binary files /dev/null and b/docs/images/software-setup/windows/installing-sourcegit-smartscreen-1.png differ diff --git a/docs/images/software-setup/windows/installing-sourcegit-smartscreen-2.png b/docs/images/software-setup/windows/installing-sourcegit-smartscreen-2.png new file mode 100644 index 0000000..2d5a754 Binary files /dev/null and b/docs/images/software-setup/windows/installing-sourcegit-smartscreen-2.png differ diff --git a/docs/images/software-setup/windows/installing-sourcegit.png b/docs/images/software-setup/windows/installing-sourcegit.png new file mode 100644 index 0000000..7862bc6 Binary files /dev/null and b/docs/images/software-setup/windows/installing-sourcegit.png differ diff --git a/docs/images/software-setup/windows/mysql-admin.png b/docs/images/software-setup/windows/mysql-admin.png new file mode 100644 index 0000000..2066a58 Binary files /dev/null and b/docs/images/software-setup/windows/mysql-admin.png differ diff --git a/docs/images/software-setup/windows/phpmyadmin-create.png b/docs/images/software-setup/windows/phpmyadmin-create.png new file mode 100644 index 0000000..103f241 Binary files /dev/null and b/docs/images/software-setup/windows/phpmyadmin-create.png differ diff --git a/docs/images/software-setup/windows/phpmyadmin-start.png b/docs/images/software-setup/windows/phpmyadmin-start.png new file mode 100644 index 0000000..f842422 Binary files /dev/null and b/docs/images/software-setup/windows/phpmyadmin-start.png differ diff --git a/docs/images/software-setup/windows/setup-xampp.png b/docs/images/software-setup/windows/setup-xampp.png new file mode 100644 index 0000000..b48fce0 Binary files /dev/null and b/docs/images/software-setup/windows/setup-xampp.png differ diff --git a/docs/images/software-setup/windows/uac-error.png b/docs/images/software-setup/windows/uac-error.png new file mode 100644 index 0000000..617d96f Binary files /dev/null and b/docs/images/software-setup/windows/uac-error.png differ diff --git a/docs/images/software-setup/windows/xampp-defaults.png b/docs/images/software-setup/windows/xampp-defaults.png new file mode 100644 index 0000000..010eeed Binary files /dev/null and b/docs/images/software-setup/windows/xampp-defaults.png differ diff --git a/docs/images/software-setup/windows/xampp-directory.png b/docs/images/software-setup/windows/xampp-directory.png new file mode 100644 index 0000000..fa57f48 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-directory.png differ diff --git a/docs/images/software-setup/windows/xampp-document-root.png b/docs/images/software-setup/windows/xampp-document-root.png new file mode 100644 index 0000000..309f835 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-document-root.png differ diff --git a/docs/images/software-setup/windows/xampp-error.png b/docs/images/software-setup/windows/xampp-error.png new file mode 100644 index 0000000..33fb6a6 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-error.png differ diff --git a/docs/images/software-setup/windows/xampp-finished.png b/docs/images/software-setup/windows/xampp-finished.png new file mode 100644 index 0000000..a6684af Binary files /dev/null and b/docs/images/software-setup/windows/xampp-finished.png differ diff --git a/docs/images/software-setup/windows/xampp-firewall.png b/docs/images/software-setup/windows/xampp-firewall.png new file mode 100644 index 0000000..10cf105 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-firewall.png differ diff --git a/docs/images/software-setup/windows/xampp-http-conf.png b/docs/images/software-setup/windows/xampp-http-conf.png new file mode 100644 index 0000000..2a22e45 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-http-conf.png differ diff --git a/docs/images/software-setup/windows/xampp-installing.png b/docs/images/software-setup/windows/xampp-installing.png new file mode 100644 index 0000000..c7f2a94 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-installing.png differ diff --git a/docs/images/software-setup/windows/xampp-language.png b/docs/images/software-setup/windows/xampp-language.png new file mode 100644 index 0000000..12c1740 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-language.png differ diff --git a/docs/images/software-setup/windows/xampp-php-ini.png b/docs/images/software-setup/windows/xampp-php-ini.png new file mode 100644 index 0000000..fb02fc2 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-php-ini.png differ diff --git a/docs/images/software-setup/windows/xampp-post-max.png b/docs/images/software-setup/windows/xampp-post-max.png new file mode 100644 index 0000000..94b8e82 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-post-max.png differ diff --git a/docs/images/software-setup/windows/xampp-ready-to-install.png b/docs/images/software-setup/windows/xampp-ready-to-install.png new file mode 100644 index 0000000..e7787d0 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-ready-to-install.png differ diff --git a/docs/images/software-setup/windows/xampp-start.png b/docs/images/software-setup/windows/xampp-start.png new file mode 100644 index 0000000..f4c4c17 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-start.png differ diff --git a/docs/images/software-setup/windows/xampp-stop-start.png b/docs/images/software-setup/windows/xampp-stop-start.png new file mode 100644 index 0000000..f721a10 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-stop-start.png differ diff --git a/docs/images/software-setup/windows/xampp-upload-max.png b/docs/images/software-setup/windows/xampp-upload-max.png new file mode 100644 index 0000000..9547397 Binary files /dev/null and b/docs/images/software-setup/windows/xampp-upload-max.png differ