Skip to content

Commit 6e59c71

Browse files
committed
Adding
1 parent ddc194b commit 6e59c71

File tree

2 files changed

+33
-11
lines changed

2 files changed

+33
-11
lines changed

README.md

+33-10
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,6 @@ Additionally, consider sharing it with the community using the badges below.
205205

206206
<p align="justify">Additionally, included under this <a href="https://github.com/gzachariadis/Python-Code-Performance" target="_black">project</a> is my code performance tester, using <a href="https://www.machinelearningplus.com/python/cprofile-how-to-profile-your-python-code/" target="_black">cProfiler</a> where you can test the efficiency of your solutions or compare your answers against mine.</p>
207207

208-
209208
## Start your own Journey
210209

211210
### Step 1 - Mirroring
@@ -215,40 +214,64 @@ git clone https://github.com/gzachariadis/Python.Challenges.git
215214
cd Python.Challenges
216215
```
217216

218-
### Step 2 - Editing Credentials
217+
### Step 2 - Configuring Credentials
219218

219+
```bash
220+
python config.py --initiate --configure
220221
```
221-
cd Python.Challenges
222-
nano credentials.json
222+
223+
```bash
224+
Usage
225+
"-i", "--initiate" Initiate Database
226+
"-c", "--configure [option]" Configure Option
227+
"--platform [platform] --username [username]"
228+
"--default-template [file_path]"
223229
```
224230

225231
### Step 3 - Creating New Entries
226232

227-
```
233+
```bash
228234
python .\add.py --link [URL]
229235
```
230236

231-
```
237+
```bash
238+
232239
Usage: python add.py [options]
233240
Options:
234241
"-h", "--help" Show this help message and exit
235242
"-l", "--link" Specify the challenge link/url (required)
236-
"-u", "--username" Specify your username
237-
"-c", "--configure" Configure script defaults
243+
"-u", "--username" Specify your username (required)
238244
"-t", "--template" Specify Template file
239245
"-s", "--submit" Submit wars.py as solution file
240246
"-n", "--notes" Submit notes as solution notes
247+
241248
```
242249

250+
<p align="justify">Username is only required input, if you haven't configured the database.</p>
251+
252+
<p align="justify">The submit option will submit the contents of wars.py file as your answer to the challenge.</p>
253+
254+
<p align="justify">The notes option will submit the contents of notes.md file as your notes to the challenge.</p>
255+
243256
### Step 4 - Updating Manually (Optional)
244257

245-
```
258+
```bash
246259
python .\update.py --platform [Platform] --username [Username]
247260
```
248261

262+
```bash
263+
Usage: python update.py [options]
264+
Options:
265+
"-h", "--help" Show this help message and exit
266+
"-u", "--username" Specify your username (required)
267+
"-a", "--append" Create folder structure for missing challenges
268+
```
269+
270+
<p align="justify">The append option will essentially call in the background the add.py file with no arguments, for each new challenge, it finds that doesn't exist in your current folder structure.</p>
271+
249272
### Step 5 - Create your own Template
250273

251-
<p align="justify">Modify the <a href="https://github.com/gzachariadis/Python.Challenges/blob/main/Template.md">Template.md</a> file according to your needs.</p>
274+
<p align="justify">Modify the <a href="https://github.com/gzachariadis/Python.Challenges/blob/main/Template.md">Template.md</a> file according to your needs, or create one yourself.</p>
252275

253276
<p align="justify">Careful when changing the "id" inside of the HTML tags, as they are used to fill the content accordingly.</p>
254277

credentials.json

-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,5 @@
1313
"username": ""
1414
}
1515
},
16-
"verbose": "False",
1716
"template": "Template.md"
1817
}

0 commit comments

Comments
 (0)