awn icon indicating copy to clipboard operation
awn copied to clipboard
verified publisher icon p12tic

Update `README` to convert to Markdown and improve the compilation instructions.

Open RokeJulianLockhart opened this issue 3 years ago • 2 comments

Modifications

  1. Of what I know, configure.ac files require autoconf to have been previously invoked. autoupdate should allow this code to be compiled for a slightly longer after development ceases entirely.

  2. I have redacted the unnecessary inline line-breaks to allow mobile devices' screens and some desktops' vertical screens to be able to observe the text. Without redaction of them, it would be unreadable via some displays.

    1. ~~Lastly, I have converted any instances of 2 backticks to 1 backtick, because 1 provides the formatting that is obviously desired by the presence of those 2 backticks, but is currently unavailable.~~

    2. Why did I strike that?

RokeJulianLockhart avatar Jul 04 '22 17:07 RokeJulianLockhart

Can we keep README as standard filename? Also please squash multiple commits fixing the same thing into a single commit.

p12tic avatar Jul 14 '22 08:07 p12tic

@p12tic, I'm new to this. I'm mostly trying to convert the code into a state whereby compilation of it is possible, so I thought that the ReadMe would be a relevantly useful thing to improve, partially by adding that information to it. However, for this process I have indeed modified and added a few minor additional files, although I believe nothing significant yet.

If you are able to, I won't hinder you separating the commits into multiple pull-requests.

Lastly, what do you mean by standard filename? If you mean that you are confused by why I have added a file-extension to it, I added it because the file solely appeared to contain text rather than markdown etcetera, so designation of its type allows it to be invoked via Windows easily, because it does not utilize MIME-types. Additionally, I utilized tabs to consistently indent each section because many studies and my personal anecdote is that indentation is more readable than the many alternative puntuative symbols necessary to demonstrate relationship. Its size should hopefully be remediated by "http://support.github.com/ticket/personal/0/1706221".

I should have added some of this to the commit-messages.

RokeJulianLockhart avatar Jul 14 '22 10:07 RokeJulianLockhart