Improve README, remove extra files #32
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit compacts several files into a single README.md and removes unused empty files along with INSTALL which seems to be unrelated to the project itself.
Added a Contribute section including reverse engineering tips from agalakhov#30
| $ autoconf | ||
| $ automake --add-missing | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Maybe add a line about running ./configure after this?
There was a problem hiding this comment.
Thanks for reviewing! Honestly, I do not think this step is needed: autoconf configures build parameters and automake builds the driver.
There was a problem hiding this comment.
I haven't used autotools in ages, so please forgive me 😛
When I run those commands I only end up with a ./configure and Makefile.in files created. To actually compile it I need to run ./configure then make afterwards -- am I doing something wrong?
There was a problem hiding this comment.
You are right! Thanks for doing a test build. I've added the missing steps to README.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an attempt to improve documentation by merging several files into a single README.md
I also removed several unused empty files along with INSTALL which seems to be unrelated to the project itself and just taken from Autotools documentation.