📝 Added example case for local setup #38

kaustubhgupta · Jul 31, 2021 · 75f4819 · 75f4819
2 parents c22f72d + ba72e3c
commit 75f4819
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -31,11 +31,17 @@ pip install -r requirements.txt
 - Therefore, you need to use `localtestingfile.py` which doesn't push the file to the repository. It only writes the index file to the root folder.  
 
 - To successfully run this file, pass arguments as:
-  ```python
- python localTestingFile.py <gh_token> <theme> <blogs> <hackathons> <stats_choice> <current_repo_path> <current_repo_branch> <resume_link> <allow_footer> <project_sort_by> <stats_customization> <social_links>
-  ```
+```python
+python localTestingFile.py <gh_token> <theme> <blogs> <hackathons> <stats_choice> <current_repo_path> <current_repo_branch> <resume_link> <allow_footer> <project_sort_by> <stats_customization> <social_links>
+```
+
+_Note: For `current_repo_path`, `stats_customization`, and `current_repo_branch`, input any random string. These parameters are disabled for local testing file. Stats customization is under development_
 
-_Note: For `current_repo_path` and `current_repo_branch`, input any random string. These parameters are disabled for local testing file_
+Example case: 
+
+```bash
+python localTestingFile.py fknkfnnds 1 true true 3 dadas dsd 'https://drive.google.com/file/d/jfksdnfkdsn' true 'forks', dnsas, "https://www.linkedin.com/in/kaustubh-gupta/, https://twitter.com/Kaustubh1828, https://medium.com/@kaustubhgupta1828"
+```
 
 - The index file will be generated and now you can make changes to improve upon the webpage.
 

diff --git a/docs/pages/Setting-Up-Locally.md b/docs/pages/Setting-Up-Locally.md
@@ -19,10 +19,16 @@ pip install -r requirements.txt
 - Therefore, you need to use `localtestingfile.py` which doesn't push the file to the repository. It only writes the index file to the root folder.  
 
 - To successfully run this file, pass arguments as:
-  ```python
- python localTestingFile.py <gh_token> <theme> <blogs> <hackathons> <stats_choice> <current_repo_path> <current_repo_branch> <resume_link> <allow_footer> <project_sort_by> <stats_customization> <social_links>
-  ```
+```python
+python localTestingFile.py <gh_token> <theme> <blogs> <hackathons> <stats_choice> <current_repo_path> <current_repo_branch> <resume_link> <allow_footer> <project_sort_by> <stats_customization> <social_links>
+```
+
+_Note: For `current_repo_path`, `stats_customization`, and `current_repo_branch`, input any random string. These parameters are disabled for local testing file. Stats customization is under development_
 
-_Note: For `current_repo_path` and `current_repo_branch`, input any random string. These parameters are disabled for local testing file_
+Example case: 
+
+```bash
+python localTestingFile.py fknkfnnds 1 true true 3 dadas dsd 'https://drive.google.com/file/d/jfksdnfkdsn' true 'forks', dnsas, "https://www.linkedin.com/in/kaustubh-gupta/, https://twitter.com/Kaustubh1828, https://medium.com/@kaustubhgupta1828"
+```
 
 - The index file will be generated and now you can make changes to improve upon the webpage.