search

FIRST-Tech-Challenge / ftcdocs

FTC Documentation Project built on Sphinx
BSD 3-Clause "New" or "Revised" License
15 stars 34 forks source link

README for Local set-up not sufficient for new users - missing Make install step #271

Open rachmo opened 3 months ago

rachmo commented 3 months ago

I just went through the instructions for the "Local Method" and it doesn't have enough detail for a fresh set-up. There is no step covering installing make.

Instructions I used with @cmacfarl 's help:

Open PowerShell with "Run as Administrator" Follow instructions from https://chocolatey.org/install run Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1')) run choco install make

Also recommend:

  1. Move the local git install step into the local section
  2. Add more detail (like a default recommendation) for what you mean by Git Install on local machine
uvidyadharan commented 3 months ago

Hi! I completely agree that the current ReadMe is very incomplete and not at all representative of the current state of the project. For a better guide I would recommend checking out PR #92 (Linked demo website below) . Unfortunately I have not had the time to make the final push to finish that PR since I have been swamped with work. Hopefully I will get around to finishing it soon.

https://first-tech-challenge-ftcdocs--92.com.readthedocs.build/en/92/contrib/tutorials/overview/overview.html