Skip to content

Commit 2531f7b

Browse files
committed
add alt text
1 parent 7ddd6be commit 2531f7b

File tree

2 files changed

+17
-221
lines changed

2 files changed

+17
-221
lines changed

caltechdata_api/Docs/CLI.md

Lines changed: 0 additions & 204 deletions
This file was deleted.

caltechdata_api/cli-documentation-for-users.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -51,41 +51,41 @@ Please install the Caltechdata_api Library via pip using the command shown:
5151
#### Step 1:
5252
Please go to https://github.com/caltechlibrary/caltechdata_api.git and click the green button that says "<> Code". Then choose the option that says "Download ZIP".
5353

54-
![alt text](<pictures-documentation/Step 1.png>)
54+
![Interface with a Download xip button](<pictures-documentation/Step 1.png>)
5555

5656
#### Step 2:
5757
Please extract the files from the downloaded zip file to a new folder (we recommend this folder be on the desktop and that you name this folder something easy to recall).
5858

59-
![alt text](<pictures-documentation/Step 2.png>)
59+
![Interface for extracting zip files](<pictures-documentation/Step 2.png>)
6060

6161
#### Step 3:
6262
In the next few steps, we shall change the directory to the folder called "caltechdata_api" inside the folder you extracted from the downloaded ZIP file. To do this, please go to the file you saved either on the file manager or on its location (this would be the desktop if you saved it there). Then, please open the folder called "caltechdata_api_main" and then right click on the folder inside it called "caltechdata_api" and choose the option that says "copy as path".
6363

64-
![alt text](<pictures-documentation/Step 3(a).png>)
64+
![Interface for changing directory](<pictures-documentation/Step 3(a).png>)
6565

6666
Above: Open the file on file manager as shown.
6767

68-
![alt text](<pictures-documentation/Step 3(b).png>)
68+
![Interface of the file manager](<pictures-documentation/Step 3(b).png>)
6969

7070
Above: Go into the folder caltechdata_api_main.
7171

72-
![alt text](<pictures-documentation/Step 3(c).png>)
72+
![Navigating the file manager](<pictures-documentation/Step 3(c).png>)
7373

7474
Above: Right click on the folder called caltechdata_api and choose the option that says copy as path.
7575

7676
#### Step 4:
7777
Next, please open a the Windows PowerShell or a code editor (we recommend using VSCode if you choose to use a code editor) and then open its Terminal.
7878

79-
![alt text](<pictures-documentation/Step 4(a).png>)
79+
![Visual studio code terminal](<pictures-documentation/Step 4(a).png>)
8080
Above: Using Visual Studio Code (VSCode)
8181

82-
![alt text](<pictures-documentation/Step 4(b).png>)
82+
![Windows PowerShell terminal](<pictures-documentation/Step 4(b).png>)
8383
Above: Using Windows PowerShell
8484

8585
#### Step 5:
8686
Next, please open the dropdown menu near the "+" icon on the top right hand corner of the terminal and choose the option that says "Git Bash". You can skip this step and go directly to the next step if you are using the Windows Powershell.
8787

88-
![alt text](<pictures-documentation/Step 5.png>)
88+
![Git bash selection](<pictures-documentation/Step 5.png>)
8989

9090
#### Step 6:
9191
Then, please type in the command as shown:
@@ -96,10 +96,10 @@ For example, it could look like this:
9696

9797
```cd "C:\Users\kshem\Desktop\Demonstration\caltechdata_api-main\caltechdata_api"```
9898

99-
![alt text](<pictures-documentation/Step 6(a).png>)
99+
![VSCode Path settings](<pictures-documentation/Step 6(a).png>)
100100
Above: Using Visual Studio Code (VSCode)
101101

102-
![alt text](<pictures-documentation//Step 6(b).png>)
102+
![PowerShell path settings](<pictures-documentation//Step 6(b).png>)
103103
Above: Using Windows PowerShell
104104

105105
### Windows Subsystem for Linux Users:
@@ -162,20 +162,20 @@ To interact with the CaltechDATA Repository, please type in this command as show
162162

163163
```python cli.py```
164164

165-
![alt text](<pictures-documentation/Interact CLI Step 1(a).png>)
165+
![VSCode interface for cli](<pictures-documentation/Interact CLI Step 1(a).png>)
166166
Above: Using Visual Studio Code (VSCode)
167167

168-
![alt text](<pictures-documentation/Interact CLI Step 1(b).png>)
168+
![PowerShell interface for cli](<pictures-documentation/Interact CLI Step 1(b).png>)
169169
Above: Using Windows PowerShell
170170

171171
Otherwise, to interact with the test instance of the CaltechDATA Repository, please type in this command as shown to open and run the CaltechDATA Command Line Interface (CLI):
172172

173173
```python cli.py -test```
174174

175-
![alt text](<pictures-documentation/Interact CLI Step 1(c) Test Instance.png>)
175+
![VSCode test cli](<pictures-documentation/Interact CLI Step 1(c) Test Instance.png>)
176176
Above: Using Visual Studio Code (VSCode)
177177

178-
![alt text](<pictures-documentation/Interact CLI Step 1(d) Test Instance.png>)
178+
![PowerShell test cli](<pictures-documentation/Interact CLI Step 1(d) Test Instance.png>)
179179
Above: Using Windows PowerShell
180180

181181
#### Step 2:
@@ -185,13 +185,13 @@ Note that the terminal is now present in the "caltechdata_api" folder or directo
185185

186186
```dir```
187187

188-
![alt text](<pictures-documentation/Interact CLI Step 2(a).png>)
188+
![PowerShell attached files](<pictures-documentation/Interact CLI Step 2(a).png>)
189189
Above: Adding your files to the directory
190190

191-
![alt text](<pictures-documentation/Interact CLI Step 2(b).png>)
191+
![VSCode attached files](<pictures-documentation/Interact CLI Step 2(b).png>)
192192
Above: Using Visual Studio Code (VSCode)
193193

194-
![alt text](<pictures-documentation/Interact CLI Step 2(c).png>)
194+
![PowerShell cli](<pictures-documentation/Interact CLI Step 2(c).png>)
195195
Above: Using Windows PowerShell
196196

197197
## Additional Steps:

0 commit comments

Comments
 (0)