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

(Doc) Update ReadMe to give a better idea of what each project is about. #15

Open
kdesnos opened this issue Apr 18, 2020 · 0 comments
Open
Labels
documentation Improve the documentation of the repository and its code.

Comments

@kdesnos
Copy link
Member

kdesnos commented Apr 18, 2020

As the number of projects in Preesm-Apps grows, it becomes more and more difficult to know what each project is about.

The root ReadMe file should give a very short description of what each project is. In addition to the "purpose" of the application it represents, it could indicate whether it is a project for Preesm, Spider, or both.

Internal, Readmes of individual project should also be updated as some of them are simple copies of the "default" sobel Readme file.

@kdesnos kdesnos added the documentation Improve the documentation of the repository and its code. label Apr 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve the documentation of the repository and its code.
Projects
None yet
Development

No branches or pull requests

1 participant