search

piql / boxing

High capacity 2D barcode format
GNU General Public License v3.0
64 stars 6 forks source link

Gitignore, remove generated files, fix build issues #1

Closed justinbass closed 6 years ago

justinbass commented 6 years ago

I added entries to configure.ac that explicitly warn a user about uninstalled packages. Before, vague error messages occurred at compile time - now they are at the configuration step. I also added compile dependencies to both README files.

Removed generated files from the public repo including documentation, as is typically best practice. Added a gitignore file to ensure these files will not accidentally upload in the future. Documentation and other generated files should be provided via a release tarball that can be versioned and uploaded to the main git repo periodically.

I tested these changes by starting from scratch on Ubuntu 16.04 and Windows 7, and the configure step provided explicit instructions for missing dependencies. After building and cleaning, no files were staged in git due to the git ignore.

These changes will make public usage (initial build and code submission) significantly easier.

oleliabo commented 6 years ago

Nice! I left the docs in there because I thought GitHub had a documentation plugin that would allow you to browse the docs, but I didn't find anything to set it up easily. So I agree, its better to have it in a release tarball for now.