Skip to content
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

Define which README to translate and which information goes to each one #3

Closed
claucece opened this issue Jun 26, 2018 · 6 comments
Closed
Labels
documentation importance low An issue that is not very important. If we can have it, great - if not, it's OK too

Comments

@claucece
Copy link
Member

claucece commented Jun 26, 2018

No description provided.

@claucece claucece added libotr-ng integration documentation importance low An issue that is not very important. If we can have it, great - if not, it's OK too and removed libotr-ng integration labels Jun 26, 2018
@olabini
Copy link
Contributor

olabini commented Sep 21, 2018

And not translate README.

@olabini
Copy link
Contributor

olabini commented Mar 10, 2019

What was the reason for us having both README and README.md initially? The README file is empty, but there was a reason we couldn't delete it, right?

claucece added a commit that referenced this issue Mar 11, 2019
@claucece
Copy link
Member Author

Well, the problem is:

if you remove the readme, autotools will complain: 'Makefile.am: error: required file './README' not found', as AM_INIT_AUTOMAKE([-Wall -Werror]), expects a README and other files. I had to pass AM_INIT_AUTOMAKE([-Wall -Werror foreing]) to fix it. See:

Among different projects, automake is used with different options and settings. Some of the most important projects have their own flavour settings supported by automake directly, as a single option, these are gnu (the default), cygnus (removed in automake 1.13), gnits and the final foreign which is meant as a "none of the above" option.

The two main differences between the gnu and foreign flavours is that the former requires the presence of a number of files in the top-level of the projects, such as NEWS, COPYING, AUTHORS, ChangeLog, README. Often enough, at least the first file in this list is just touch-ed to stop automake from failing.

https://autotools.io/automake/options.html#automake.options.flavors

Do you think the change is enough? @olabini

@olabini
Copy link
Contributor

olabini commented Mar 11, 2019

Hmm, interesting. Well, the other choice would be to just keep README and delete the README.md - I don't care that much about having the .md extension.

@claucece
Copy link
Member Author

I mean.. we are also using the foreign option in libotr-ng because of this reasons. The reason why people wanted the .md file was so it rendered 'nicely'.

@olabini
Copy link
Contributor

olabini commented Mar 11, 2019

Ah, in that case that's fine with me =) Let's keep this solution. Although I don't care about it rendering 'nicely'... =)

@olabini olabini closed this as completed Mar 11, 2019
Pidgin plugin with OTRv4 automation moved this from To Do to Done Mar 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation importance low An issue that is not very important. If we can have it, great - if not, it's OK too
Projects
Development

No branches or pull requests

2 participants