Skip to content
Update Developer Guide authored by Brian's avatar Brian
......@@ -23,11 +23,7 @@ As stated above, SCDV uses [Poetry][] to manage dependencies and requirements. S
While there are many ways to configure your development environment, the following methods are known to work/repeatable.
### I know what I'm doing quickstart
#### Initial Setup
Recommended setup:
##### I know what I'm doing quickstart
```bash
mkdir -p scmodding/{tools,frameworks}/
......@@ -41,11 +37,11 @@ poetry install
poetry run python -m pip install -e ../../frameworks/scdatatools
```
### Windows Development Guide
### System Dependencies
> All command snippets are assumed to be in Git Bash unless specifically stated otherwise
#### Windows
#### Dependencies
> All command snippets are assumed to be in Git Bash unless specifically stated otherwise
##### Git Bash
......@@ -55,23 +51,48 @@ Install from https://git-scm.com/downloads.
pyenv-win provides an easy way to manage multiple Python versions on Windows. The easiest/preferred method is to install using [chocolatey](https://chocolatey.org/install). Follow the instructions here: https://pyenv-win.github.io/pyenv-win/#installation
Install Python 3.9.2 with `pyenv-win`
- Install Python 3.9.2 with `pyenv-win`
```bash
pyenv install 3.9.2
```
##### poetry
[Install poetry](https://python-poetry.org/docs/#windows-powershell-install-instructions):
```bash
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
```
#### Linux/OSX
##### pyenv
pyenv provides an easy way to manage multiple Python versions on Linux/OSX. Set it up by following the instructions here https://github.com/pyenv/pyenv-installer
- Install Python 3.9.2 with `pyenv`
```bash
pyenv install 3.9.2
```
> Every distro is different. If pyenv fails to build python, check https://github.com/pyenv/pyenv/wiki#suggested-build-environment
##### poetry
[Install poetry](https://python-poetry.org/docs/#windows-powershell-install-instructions) using PowerShell:
[Install poetry](https://python-poetry.org/docs/#osx--linux--bashonwindows-install-instructions):
```powershell
(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python -
```bash
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
```
### Clone
The recommend folder structure is created as follows
### Cloning
The recommend folder structure is created as follows.
> If you plan on making modifications, you should first fork `scdv` and `scdatatools` and clone using your fork's repo urls
```bash
mkdir -p scmodding/{tools,frameworks}/
......
......