/graphpass

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

File inventory; what's required, what's not #40

Closed
ruebot opened this Issue Aug 28, 2018 · 1 comment

Comments

Assignees
No one assigned
Labels
Projects
None yet
Milestone
No milestone
2 participants
@ruebot @greebie
@ruebot
Member

ruebot commented Aug 28, 2018

  1. Docs
    1. How are these docs created?
    2. This directory should be renamed to doc
  2. assets
    1. Are these just test fixtures?
  3. headers
    1. Does this need to be outside the src directory?
  4. src
    1. Can we move everything in the src root to src/main?
  5. tests
    1. Can we move this to src/tests?
  6. unity
    1. Is this source code from another project?
  7. Doxyfile
    1. Are we using Doxygen to build docs?
  8. configure.scan
    1. Should this have been removed in conjunction with the resolution to #29?

@ruebot ruebot added question discussion labels Aug 28, 2018

@greebie

This comment has been minimized.

Show comment
Hide comment
@greebie

greebie Aug 28, 2018

Collaborator
  1. Docs are created using Doxygen.
  2. "Assets" are example files. I think we can change this to "examples." Currently, if you have no -f flag, it will run graphpass on cpp2.graphml. We could probably provide a better example though. It might be nice to have a small selection of aut derivatives to show them off.
  3. headers is a necessary evil unfortunately. It could probably be moved to src - that will involve changes to the Makefile.
    4, 5 I'll do some research on a good way to structure the project. I have a manual from the library even!
    6 Yes. Unity is a test suite for c. I believe all the licensing info is in the associated files. In a way, I think it may be overkill. I'm pretty sure we could run the tests via Make instead.
  4. Yes.
  5. I think this could be a feature branch. The benefit is that a proper autoconf setup would check and install dependencies, making installation easier. I tried and failed, but maybe the c manual will help.
Collaborator

greebie commented Aug 28, 2018

  1. Docs are created using Doxygen.
  2. "Assets" are example files. I think we can change this to "examples." Currently, if you have no -f flag, it will run graphpass on cpp2.graphml. We could probably provide a better example though. It might be nice to have a small selection of aut derivatives to show them off.
  3. headers is a necessary evil unfortunately. It could probably be moved to src - that will involve changes to the Makefile.
    4, 5 I'll do some research on a good way to structure the project. I have a manual from the library even!
    6 Yes. Unity is a test suite for c. I believe all the licensing info is in the associated files. In a way, I think it may be overkill. I'm pretty sure we could run the tests via Make instead.
  4. Yes.
  5. I think this could be a feature branch. The benefit is that a proper autoconf setup would check and install dependencies, making installation easier. I tried and failed, but maybe the c manual will help.

@ruebot ruebot removed the discussion label Sep 3, 2018

@ruebot ruebot referenced this issue Sep 3, 2018

Closed

Clean-up and organize project; partially resolves #40. #48

ruebot added a commit that referenced this issue Sep 3, 2018

@ruebot
Clean-up and organize project; partially resolves #40. 
- Moves Docs -> doc
- Moves tests -> src/tests
- Moves headers -> src/headers
- Moves src/*.c -> src/main
- Moves unity -> vendor/unity
- Updates Doxygen config
- Update Doxygen generated docs
- Update README
- Update all src files that need to be updated to reflect re-org
- Update Makefile so project builds
- Clean-up whitespace in src files
- Simplify Makefile
Verified
This commit was signed with a verified signature.
@ruebot ruebot Nick Ruest
GPG key ID: 417FAF1A0E1080CD Learn about signing commits
24f8903

ruebot added a commit that referenced this issue Sep 3, 2018

@ruebot
Clean-up and organize project; resolves #40. 
- Moves Docs -> doc
- Moves tests -> src/tests
- Moves headers -> src/headers
- Moves src/*.c -> src/main
- Moves unity -> vendor/unity
- Updates Doxygen config
- Update Doxygen generated docs
- Update README
- Update all src files that need to be updated to reflect re-org
- Update Makefile so project builds
- Clean-up whitespace in src files
- Simplify Makefile
Verified
This commit was signed with a verified signature.
@ruebot ruebot Nick Ruest
GPG key ID: 417FAF1A0E1080CD Learn about signing commits
8bd99a1

@ruebot ruebot referenced this issue Sep 3, 2018

Merged

Clean-up and organize project; resolves #40. #50

@greebie greebie closed this in 3a99b92 Sep 4, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment