Skip to content

Improve README, remove extra files#32

Open
jekader wants to merge 3 commits intoagalakhov:masterfrom
jekader:master
Open

Improve README, remove extra files#32
jekader wants to merge 3 commits intoagalakhov:masterfrom
jekader:master

Conversation

@jekader
Copy link

@jekader jekader commented Nov 3, 2020

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.

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
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a line about running ./configure after this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for reviewing! Honestly, I do not think this step is needed: autoconf configures build parameters and automake builds the driver.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants