Skip to content

Commit 459ed33

Browse files
Fix links and improve README instructions
Updated links to point to the correct sections and added clarity to instructions.
1 parent 09b4129 commit 459ed33

1 file changed

Lines changed: 17 additions & 16 deletions

File tree

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -278,12 +278,12 @@ OR
278278
```
279279
This will allow you to download the Zip file or clone the repository successfully. If you have the Zip file extract it onto a Python IDE Directory folder of the new project, but you must have Python installed on your machine.
280280
## **2. Options to Run Application**
281-
- **a)** [Run through a Python IDE](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/main/README.md#a-a-set-up-pycharm-set-up-a-virtual-environment-install-dependencies-run-application)
282-
- **b)** [Run through Python Terminal after setting up the virtual environment](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/main/README.md#b-set-up-a-virtual-environment-install-dependencies-run-application)
283-
- **c)** [Run through Python IDE after Forking Repository](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/main/README.md#c-after-forking-set-up-pycharm-set-up-virtual-environment-install-dependencies-run-application)
281+
- **a)** [Run through a Python IDE](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App?tab=readme-ov-file#a-a-set-up-pycharm-set-up-a-virtual-environment-install-dependencies-run-application)
282+
- **b)** [Run through Python Terminal after setting up the virtual environment](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App?tab=readme-ov-file#b-set-up-a-virtual-environment-install-dependencies-run-application)
283+
- **c)** [Run through Python IDE after Forking Repository](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App?tab=readme-ov-file#c-a-after-forking-set-up-pycharm-set-up-virtual-environment-install-dependencies-run-application)
284284

285285
### **a-a. Set up PyCharm, Set up a virtual environment, Install dependencies, Run Application**
286-
- If you do not have PyCharm and want to install [VS Code (Visual studio Code) go to a-b](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/main/README.md#a-b-set-up-visual-studio-code-vs-code-set-up-a-virtual-environment-install-dependencies-run-application)
286+
- If you do not have PyCharm and want to install [VS Code (Visual studio Code) go to a-b](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App?tab=readme-ov-file#a-b-set-up-visual-studio-code-vs-code-set-up-a-virtual-environment-install-dependencies-run-application)
287287
- Before running the application, make sure you have **Python** installed on your machine. You can download Python from the official website: [Download Python](https://www.python.org/downloads/). Once Python is installed, you'll need to install the dependencies for the project either through the PYTHON IDE terminal that you installed PyCharm [Download PyCharm Community for Windows](https://www.jetbrains.com/pycharm/download/?section=windows) OR [Download PyCharm Community for Mac](https://www.jetbrains.com/pycharm/download/?section=mac) OR [Download PyCharm Community for Linux](https://www.jetbrains.com/pycharm/download/?section=linux).
288288
- Then you must open PyCharm:
289289
- Make a new Project with these instructions: [Create a Python Project](https://www.jetbrains.com/help/pycharm/creating-empty-project.html)
@@ -309,7 +309,7 @@ python main.py
309309
- Then while staying on that file click on the **Run** button which is the Green Arrow.
310310

311311
### **a-b. Set up Visual Studio Code (VS Code), Set up a virtual environment, Install dependencies, Run Application**
312-
- If you do not have VS Code (Visual studio Code) and want to install [PyCharm go to a-a](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/main/README.md#a-a-set-up-pycharm-set-up-a-virtual-environment-install-dependencies-run-application)
312+
- If you do not have VS Code (Visual studio Code) and want to install [PyCharm go to a-a](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App?tab=readme-ov-file#a-a-set-up-pycharm-set-up-a-virtual-environment-install-dependencies-run-application)
313313
- Before running the application, make sure you have **Python** installed on your machine. You can download Python from the official website: [Download Python](https://www.python.org/downloads/). Once Python is installed, you'll need to install the dependencies for the project either through the PYTHON IDE terminal that you installed VS Code [Download VS CODE (DOWNLOADS)](https://code.visualstudio.com/Download). Then read the Overview: [VSC Overview](https://code.visualstudio.com/docs/setup/setup-overview).
314314
- Then you must open VS CODE:
315315
- INSTALL *all* [**EXTENTIONS for PYTHON + OTHERS**](https://code.visualstudio.com/docs/getstarted/extensions)
@@ -366,7 +366,7 @@ python main.py
366366
```
367367

368368
### **c-a. After Forking, Set up PyCharm, Set up virtual environment, Install dependencies, Run Application**
369-
- If you do not have PyCharm and want to install [VS Code (Visual studio Code) go to c-b](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/main/README.md#c-b-after-forking-set-up-visual-studio-code-vs-code-set-up-virtual-environment-install-dependencies-run-application)
369+
- If you do not have PyCharm and want to install [VS Code (Visual studio Code) go to c-b](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App?tab=readme-ov-file#c-b-after-forking-set-up-visual-studio-code-vs-code-set-up-virtual-environment-install-dependencies-run-application)
370370
- Before running the application, make sure you have **Python** installed on your machine. You can download Python from the official website: [Download Python](https://www.python.org/downloads/). Once Python is installed, you'll need to install the dependencies for the project either through the PYTHON IDE terminal that you installed PyCharm [Download PyCharm Community for Windows](https://www.jetbrains.com/pycharm/download/?section=windows) OR [Download PyCharm Community for Mac](https://www.jetbrains.com/pycharm/download/?section=mac) OR [Download PyCharm Community for Linux](https://www.jetbrains.com/pycharm/download/?section=linux).
371371
- Then you must open PyCharm:
372372
- Make a new Project with these instructions: [Create a Python Project](https://www.jetbrains.com/help/pycharm/creating-empty-project.html)
@@ -389,7 +389,7 @@ python main.py
389389
- Then while staying on that file click on the **Run** button which is the Green Arrow.
390390

391391
### **c-b. After Forking, Set up Visual Studio Code (VS Code), Set up virtual environment, Install dependencies, Run Application**
392-
- If you do not have VS Code (Visual studio Code) and want to install [PyCharm go to c-a](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/main/README.md#c-a-after-forking-set-up-pycharm-set-up-virtual-environment-install-dependencies-run-application)
392+
- If you do not have VS Code (Visual studio Code) and want to install [PyCharm go to c-a](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App?tab=readme-ov-file#c-a-after-forking-set-up-pycharm-set-up-virtual-environment-install-dependencies-run-application)
393393
- Before running the application, make sure you have **Python** installed on your machine. You can download Python from the official website: [Download Python](https://www.python.org/downloads/). Once Python is installed, you'll need to install the dependencies for the project either through the PYTHON IDE terminal that you installed VS Code [Download VS CODE (DOWNLOADS)](https://code.visualstudio.com/Download). Then read the Overview: [VSC Overview](https://code.visualstudio.com/docs/setup/setup-overview).
394394
- Then you must open VS CODE:
395395
- INSTALL *all* [**EXTENTIONS for PYTHON + OTHERS**](https://code.visualstudio.com/docs/getstarted/extensions)
@@ -488,8 +488,8 @@ This document outlines the deliverables for a CS50 Capstone Final Project: a Tra
488488
### Version Control with Git
489489
This project uses Git for version control. Git will be used to track the progress of the project, manage code changes, and ensure collaboration between developers. Every change made to the codebase will be tracked with commit messages, providing a clear history of the project's development. Here's how we manage code changes:
490490
#### Branching and Commit Process
491-
- Create a Branch: Each developer creates a separate feature branch for a specific task (e.g., name-of-team-member/MainMenu; name-of-team-member/TicTacToe.py, etc.).
492-
- Commit Changes: Developers commit incremental changes with descriptive commit messages (e.g., Added game over condition for TicTacToe.py, Triva.py, Breakout.py).
491+
- Create a Branch: Each developer creates a separate feature branch for a specific task
492+
- Commit Changes: Developers commit incremental changes with descriptive commit messages
493493
- Push Changes: After completing tasks in a remote branch that was created, developers push the branch to GitHub.
494494
- Pull Request (PR): Create a Pull Request for code review. Once approved, the changes are merged into the main branch.
495495
### Code Review and Merge
@@ -518,7 +518,7 @@ This project uses Git for version control. Git will be used to track the progres
518518
- Go to [https://github.com/VictoriaRaven/Translator-Language-Dictionary-App](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App)
519519
- Go to Actions Tab
520520
- If Workflow is Disabled, Enable it
521-
- Click on the Workflow [1) Auto Run Tests For Mac with all push; Auto Run Tests For Windows with all push; Auto Run Tests For Ubuntu with all push ]
521+
- Click on the Workflow [1) Auto Run Tests For Mac with all push; Auto Run Tests For Windows with all push; Auto Run Tests For Ubuntu with all push ](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/actions)
522522
- Go to the right side of “This workflow has a workflow_dispatch event trigger.”
523523
- Click on Run Workflow
524524
- Make sure it’s on Main branch (the .yml files autoruns on separate branches even if run through main)
@@ -568,6 +568,7 @@ python -m pytest
568568
- Go to the docs to find a copy of the Excel/Sheets/table for manual testing.
569569
- Or Go to the docs in to get the link to the Excel/Sheets/table for manual testing.
570570
- This is Manual Tests using the Excel/Sheets/table method
571+
- Docs Link to All Testing: [Here](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/tree/main/docs)
571572
1) **Steps/Procedures**:
572573
- Command line, terminal or PowerShell steps:
573574
- Download the code from GitHub in the “main” branch of folder containing ```tests/...all test .py files here..." (Works for WIN; MAC; UBU)```. Refer to README.md for help.
@@ -645,7 +646,7 @@ Automated testing was implemented using Python’s import frameworks to validate
645646
## Project Architecture
646647
This portion is included in the document folder **"docs"** and the diagrams included in one of the sections.
647648
### Start of the Implementation:
648-
- **Implementation Of GUI**:
649+
- **Implementation Of GUI**: All of it is in the DOCS folder. [HERE](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/tree/main/docs)
649650
### Class/UML/Use Case/Activity Diagrams
650651
The use case diagram illustrates how users interact with the application: starting from launching the app, selecting a option from the main menu (main.py), and engaging with the mechanics. The activity diagram shows the flow of actions, starting from the application launch, progressing through the deicitonary tabs selection of Open Admin Panel, importing/exporting data, editing data, veiwing data, page changes. The class and uml diagram is similar to the activity diagram but includes the classes, codes, and functions/methods and how it intreacts with each other.
651652
## Overview of Progress and Conclusion
@@ -686,13 +687,13 @@ The use case diagram illustrates how users interact with the application: starti
686687
- Monitor post-deployment performance and user feedback for future updates.
687688

688689
### Contact
689-
Feel free to pm me (VictoriaRaven) if you want to use my code under a specific license and without needing to fork my repository.
690-
## Contributing
691-
Please read [CONTRIBUTING.md](README.md) for details on our code
692-
of conduct, and the process for submitting pull requests to me.
690+
Feel free to pm me (VictoriaRaven) if you want to use my code under a specific license and without needing to fork my repository and also for details on our code
691+
of conduct, and the process for submitting pull requests to me if you wish to collaborate.
692+
693693
## Authors
694694
- **Victoria Lee** - [VictoriaRaven](https://github.com/VictoriaRaven)
695-
- See also the list of [contributors](https://github.com/VictoriaRaven/Translator-Language-Dictionary-App/main/README.md) who participated in this project.
695+
- Contributers: None/NA
696+
696697
## Acknowledgments
697698
- [Google Scholar](https://scholar.google.com/)
698699
- [Python Doc](https://docs.python.org/3/)

0 commit comments

Comments
 (0)