@@ -20,4 +20,46 @@ GitHub-style markdown.
20
20
21
21
> Note: As you can tell, the documentation is _ definitely_ not finished. While I'm writing this documentation, you
22
22
> can either wait for me to finish (not recommended) or ping me on Discord on the Discord server linked above.
23
- > (recommended)
23
+ > (recommended)
24
+
25
+ ## Table of Contents
26
+ 1 . [ Installing] ( #installing )
27
+ 1 . [ Installing from source] ( #installing-from-source )
28
+
29
+ ## Installing
30
+
31
+ Due to how new this project is, there are no binaries currently.
32
+
33
+ ### Installing from source
34
+
35
+ 1 . [ Download] ( https://git-scm.com/downloads ) and install Git. It does not matter what editor you use for Git's default.
36
+ 1 . Or...download this repo via the ` Download ZIP ` option under the green ` Code ` button, shown in Figure 1.1:
37
+
38
+ ![ A picture on the Download Zip button on the GitHub page] ( assets/1/1.png )
39
+
40
+ 2 . [ Download] ( https://www.python.org/downloads/ ) and install Python ** 3.9** . (Because I use type definitions, but 3.8
41
+ seems to work too)
42
+ 1 . Make sure to check ` Add Python 3.x to PATH ` , as shown in Figure 1.2:
43
+
44
+ ![ A picture of the Python 3.9 installer with the Add Python 3.9 to PATH checkbox checked] ( assets/1/2.png )
45
+
46
+ 2 . Make sure to also install Tk/Tcl support! If you can access the IDLE, then Tk/Tcl is installed, as shown in
47
+ Figure 1.3: (Only applies if you are using the ` Customize installation ` option in the installer)
48
+
49
+ ![ A picture of the Python 3.9 installer with the tcl/tk and IDLE checkbox checked] ( assets/1/3.png )
50
+
51
+ If you are building Python,
52
+ [ here is a guide on building Python on Debian I found helpful] ( https://linuxize.com/post/how-to-install-python-3-8-on-debian-10/ ) .
53
+ Before building, you may need to install a bunch of packages using ` apt ` :
54
+ ` sudo apt install libbz2-dev libgdbm-dev libgdbm-compat-dev liblzma-dev libsqlite3-dev libssl-dev uuid-dev libreadline-dev zlib1g-dev tk-dev libffi-dev ` .
55
+
56
+ 3 . If you are on Windows, I would also install the
57
+ [ Windows Terminal] ( https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701 ) while you are at it.
58
+
59
+ 4 . If you installed Git, ` cd ` into a convenient directory (like the home directory or the desktop) and run:
60
+ ``` commandline
61
+ git clone https://github.com/UnsignedArduino/CircuitPython-Project-Manager
62
+ cd CircuitPython-Project-Manager
63
+ ```
64
+ 1. If you downloaded the ZIP, move the downloaded ZIP to somewhere convenient (ex. home directory or desktop),
65
+ extract it, open a terminal and `cd` into the extracted directory.
0 commit comments