Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the README file under the source directory #762

Closed
wants to merge 2 commits into from

Conversation

amichai-bd
Copy link
Collaborator

@amichai-bd amichai-bd commented Dec 6, 2024

Fixes #761

Improve the README file under the source directory.

  • Add a detailed description of the directory structure and the purpose of each subdirectory.
  • Mention the main components of the project and their functionalities.
  • Include links to the relevant subdirectories for more information.

For more details, open the Copilot Workspace session.

Fixes #761

Improve the README file under the `source` directory.

* Add a detailed description of the directory structure and the purpose of each subdirectory.
* Mention the main components of the project and their functionalities.
* Include links to the relevant subdirectories for more information.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/FPGA-MAFIA/fpga_mafia/issues/761?shareId=XXXX-XXXX-XXXX-XXXX).
* **source/README.md**
  - Add detailed description of the directory structure and the purpose of each subdirectory
  - Mention the main components of the project and their functionalities
  - Remove unnecessary links to external resources

* **source/fabric/README.md**
  - Add detailed description of the fabric architecture, its components, and their functionalities
  - Remove unnecessary links to external resources

* **source/fabric/router/README.md**
  - Add detailed description of the router, its components, and their functionalities
  - Remove unnecessary links to external resources

* **source/mini_core/README.md**
  - Add detailed description of the mini core, its components, and their functionalities
  - Remove unnecessary links to external resources
@amichai-bd amichai-bd closed this Dec 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review this github repository, and improve the README file under the source directory
1 participant