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

Move editor support from README.md to EDITORS.md #3624

Merged
merged 1 commit into from Sep 1, 2020

Conversation

erf
Copy link
Contributor

@erf erf commented Aug 26, 2020

Not sure you want this, but i thought i clean up the README.md somewhat, by moving the editor support list to a separate file and link to it from README.md.

@damon-kwok
Copy link
Contributor

Isn't it good to stay on the homepage?

@jasoncarr0
Copy link
Contributor

I'm not certain I agree with this right now. The current README is reasonably terse and we may want to give more thought to how we frame the tooling situation (should we move Operating Systems in there as well?)

@erf
Copy link
Contributor Author

erf commented Aug 27, 2020

My thinking was that editor support is perhaps not the most important thing to mention, is now taking up the most space and and a few other sections have already been moved to separate files.

@SeanTAllen
Copy link
Member

Taking a look at the README as it now stands, I agree with @erf that editors is taking up an unusually large amount of space compared to other items. I'm in favor of this change but won't merge until there has been more discussion. At the latest, this will be resolved and a decision will be made no later than the next sync meeting. The next one is currently scheduled for September 1st.

@rhagenson
Copy link
Member

I am in support of a switch to EDITOR.md as the editors takes up ~1/3 of the space in README.

However, if think we are dangerously close to having README just be big sections headers each containing a single link to another file. Structurally, I would suggest a reorganization to a "definition list" style a la:


Pony

Pony is an open-source, object-oriented, actor-model, capabilities-secure, high-performance programming language.

Status

Pony is still pre-1.0 and as such, semi-regularly introduces breaking changes. These changes are usually fairly easy to adapt to. Applications written in Pony are currently used in production environments.

Supported platforms

Operating Systems

  • FreeBSD
  • Linux
  • macOS
  • Windows 10

CPUs

  • Full support for 64-bit platforms
    • x86 and ARM CPUs only
  • Partial support for 32-bit platforms
    • The arm and armhf architectures are tested via CI (Continuous
      Integration testing)

More Information

Contributing

We welcome contributions to Pony. Please read through CONTRIBUTING.md for details on how to get started.

License

Pony is distributed under the terms of the 2-Clause BSD License. See LICENSE for details.


My inclination is to include only the elements that will be a definite stopgap to adopting Pony, meanwhile all the elements for active Pony users is capture by a link to a more complete treatment.

@SeanTAllen
Copy link
Member

I like @rhagenson's suggestion and would definitely be in favor.

@SeanTAllen
Copy link
Member

@rhagenson I'm going to merge this. When you have time, can you follow through on your suggestion?

@erf Thanks for taking the initiative on this.

@SeanTAllen SeanTAllen merged commit 72a005c into ponylang:master Sep 1, 2020
@erf erf deleted the editors-doc branch September 1, 2020 17:15
rhagenson added a commit that referenced this pull request Sep 4, 2020
SeanTAllen pushed a commit that referenced this pull request Sep 4, 2020
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.

None yet

5 participants