Skip to content

Commit

Permalink
readme links fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
MuhammadSulaiman001 committed Nov 19, 2023
1 parent 4cdeb43 commit 2423191
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions OpenGLab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

Each project has `README.md` file, here is a brief description about them:

- [LabDemos](./OpenGLab/LabDemos) application: shows a list of demos, you can choose to run a demo by entering its number.
- [LabDemos.Exercises](./OpenGLab/LabDemos.Exercises) application: similar to LabDemos, but the implementation is left to you as exercise :smile:,
- [LabDemos](./LabDemos) application: shows a list of demos, you can choose to run a demo by entering its number.
- [LabDemos.Exercises](./LabDemos.Exercises) application: similar to LabDemos, but the implementation is left to you as exercise :smile:,
- This will help you getting handy with the tech.
- [OpenGL.SharedModule](./OpenGLab/OpenGL.SharedModule) Library:
- [OpenGL.SharedModule](./OpenGL.SharedModule) Library:
1. Contains shared code .c and .cpp files (ex. glad.c, stb_image.cpp, imgui*.cpp, etc...)
2. Also, I've put global dependencies' artifacts (i.e. .h, .dll, .lib) in this library
3. This library does depends on nothing, but all other apps (ex. `LabDemos`, `LabDemos.Exercises` and Homework.*) depends on it, except for:
- [LegacyDemo.Yuck](./OpenGLab/LegacyDemo.Yuck) application: A showcase of legacy opengl app
- [LegacyDemo.Yuck](./LegacyDemo.Yuck) application: A showcase of legacy opengl app
- Dependencies of this application are bundled within it, *Not within OpenGL.SharedModule*. So this project does not depend on any other project
- It shows that modern/legacy projects can be found in the same solution!
- [Homework.*](./OpenGLab/.): details for each homework can be found in README.md file in homework's root folder
- [Homework.*](./): details for each homework can be found in README.md file in homework's root folder
- Homerowk(s) will be announced in [Discussions](https://github.com/MuhammadSulaiman001/opengl-lab/discussions)
- To watch all activities on this repo, select "All Activity" in Watch dropdown in the repo.
- [UnitTests](./OpenGLab/UnitTests): Unit Tests everywhere[^1] :100:
- [UnitTests](./UnitTests): Unit Tests everywhere[^1] :100:

![projects-dependency-diagram](./../res/projects-dependency-diagram.png)

Expand All @@ -25,4 +25,4 @@ NOTEs:
- **Moreover, Don't fork this repo and push your code to your public repo!**
- **For Homeworks: User should be able to run the application (especially homeworks) by double-clicking on .exe**

[^1]: In general, you should create unit test project(s) wherever you work on a [modular] application.
[^1]: In general, you should create unit test project(s) wherever you work on a [modular] application.

0 comments on commit 2423191

Please sign in to comment.