forks/apenwarr-redo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
apenwarr-redo/docs/Contributing.md

67 lines
2.6 KiB
Markdown
Raw Normal View History

Refactor the huge README.md into the more structured mkdocs. I also cleaned up the installation section and added links to various competing redo implementations. The new README.md is basically just link to the docs on readthedocs.org, and a link to the mailing list. These docs need a *lot* more work, but this is enough of an improvement that I'll commit it anyway for now.
2018-11-16 03:13:33 -05:00
# License
My version of redo was written without ever seeing redo code by Bernstein or
Change license to Apache 2.0. Mailing list discussion was here: https://groups.google.com/forum/#!topic/redo-list/wLMZMxtn4wo Several more contributors replied to me personally to say that they don't have a problem with the change (and several consider the change to be an improvement). The overwhelming majority of everything in the redo repo was written by me, so I have the right to change the license unilaterally anyway, subject to a few rules. Since the new license actually removes licensing/usage restrictions for everyone, this should be no problem.
2018-11-26 17:04:31 -05:00
Grosskurth, so I own the entire copyright. It's distributed under the terms
of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0),
which you can find in the file called
[LICENSE](https://github.com/apenwarr/redo/tree/master/LICENSE). (Previous
versions of redo were distributed under the GNU LGPL, but this [changed in
2018](https://groups.google.com/forum/#!topic/redo-list/wLMZMxtn4wo).)
minimal/do is in the public domain so that it's as easy as possible
Even more doc cleanups.
2018-11-26 17:32:19 -05:00
to include inside your own projects, to help end users who don't
Refactor the huge README.md into the more structured mkdocs. I also cleaned up the installation section and added links to various competing redo implementations. The new README.md is basically just link to the docs on readthedocs.org, and a link to the mailing list. These docs need a *lot* more work, but this is enough of an improvement that I'll commit it anyway for now.
2018-11-16 03:13:33 -05:00
have a copy of redo.
# How can I help?
Nowadays, redo is good enough for real production use, and some people
are using it for real work. That said, it has
docs/cookbook/redoconf-simple: a simple redoconf C++ project. This is a little simpler than the docs/cookbook/c project, which doesn't actually have a doc yet because there was too much to explain. I think I might make that a follow-on cookbook chapter, for people who have read this simple one. I think this doc is maybe a little too long; I intended it to be "here's what you do to get started" but it turned into "here's what you do to get started, and why it works, in excruciating detail." Not quite sure how to fix. (Also updated some other parts of the docs to refer to redoconf as a real thing now instead of a "maybe someone should write this" thing.)
2019-03-05 23:33:11 -05:00
not reached version 1.0 and there are always going to be bugs.
Refactor the huge README.md into the more structured mkdocs. I also cleaned up the installation section and added links to various competing redo implementations. The new README.md is basically just link to the docs on readthedocs.org, and a link to the mailing list. These docs need a *lot* more work, but this is enough of an improvement that I'll commit it anyway for now.
2018-11-16 03:13:33 -05:00
If you run into a problem, it's really helpful if you report it to the
mailing list below (with or without subscribing first). We really want to
know if redo is acting weird for you. Even if the problem turns out to be
operator error, we can use that information to try to improve this
documentation.
Small feature additions are also welcome, but you might want to ask on the
mailing list before you start working on it. The code is still evolving and
might not be the same by the time you submit your pull request.
docs/cookbook/redoconf-simple: a simple redoconf C++ project. This is a little simpler than the docs/cookbook/c project, which doesn't actually have a doc yet because there was too much to explain. I think I might make that a follow-on cookbook chapter, for people who have read this simple one. I think this doc is maybe a little too long; I intended it to be "here's what you do to get started" but it turned into "here's what you do to get started, and why it works, in excruciating detail." Not quite sure how to fix. (Also updated some other parts of the docs to refer to redoconf as a real thing now instead of a "maybe someone should write this" thing.)
2019-03-05 23:33:11 -05:00
Contributions to [redoconf](/cookbook/redoconf-simple/) are very welcome.
For example, you might want to contribute detectors for new libraries or
compilers.
Some of the best things you can do for redo are:
Refactor the huge README.md into the more structured mkdocs. I also cleaned up the installation section and added links to various competing redo implementations. The new README.md is basically just link to the docs on readthedocs.org, and a link to the mailing list. These docs need a *lot* more work, but this is enough of an improvement that I'll commit it anyway for now.
2018-11-16 03:13:33 -05:00
- Convert your projects to using it. Without users, no project is
successful.
Improved documentation. Removed the Cookbook link for now, since it's empty.
2018-11-20 09:50:37 -05:00
- Convince your favourite OS distro to build and include (up to date!) redo
docs/cookbook/redoconf-simple: a simple redoconf C++ project. This is a little simpler than the docs/cookbook/c project, which doesn't actually have a doc yet because there was too much to explain. I think I might make that a follow-on cookbook chapter, for people who have read this simple one. I think this doc is maybe a little too long; I intended it to be "here's what you do to get started" but it turned into "here's what you do to get started, and why it works, in excruciating detail." Not quite sure how to fix. (Also updated some other parts of the docs to refer to redoconf as a real thing now instead of a "maybe someone should write this" thing.)
2019-03-05 23:33:11 -05:00
packages. We especially need someone to help with getting redo included
in debian.
Improved documentation. Removed the Cookbook link for now, since it's empty.
2018-11-20 09:50:37 -05:00
Even more doc cleanups.
2018-11-26 17:32:19 -05:00
- Help proofreading this documentation, and send patches or pull requests
docs/cookbook/redoconf-simple: a simple redoconf C++ project. This is a little simpler than the docs/cookbook/c project, which doesn't actually have a doc yet because there was too much to explain. I think I might make that a follow-on cookbook chapter, for people who have read this simple one. I think this doc is maybe a little too long; I intended it to be "here's what you do to get started" but it turned into "here's what you do to get started, and why it works, in excruciating detail." Not quite sure how to fix. (Also updated some other parts of the docs to refer to redoconf as a real thing now instead of a "maybe someone should write this" thing.)
2019-03-05 23:33:11 -05:00
with improvements and additions.
Even more doc cleanups.
2018-11-26 17:32:19 -05:00
- Join the mailing list (below) to discuss design changes or bugs.
Refactor the huge README.md into the more structured mkdocs. I also cleaned up the installation section and added links to various competing redo implementations. The new README.md is basically just link to the docs on readthedocs.org, and a link to the mailing list. These docs need a *lot* more work, but this is enough of an improvement that I'll commit it anyway for now.
2018-11-16 03:13:33 -05:00
- Tell your friends!
# Mailing list
docs/cookbook/redoconf-simple: a simple redoconf C++ project. This is a little simpler than the docs/cookbook/c project, which doesn't actually have a doc yet because there was too much to explain. I think I might make that a follow-on cookbook chapter, for people who have read this simple one. I think this doc is maybe a little too long; I intended it to be "here's what you do to get started" but it turned into "here's what you do to get started, and why it works, in excruciating detail." Not quite sure how to fix. (Also updated some other parts of the docs to refer to redoconf as a real thing now instead of a "maybe someone should write this" thing.)
2019-03-05 23:33:11 -05:00
You should join the `redo-list@googlegroups.com` mailing list!
Refactor the huge README.md into the more structured mkdocs. I also cleaned up the installation section and added links to various competing redo implementations. The new README.md is basically just link to the docs on readthedocs.org, and a link to the mailing list. These docs need a *lot* more work, but this is enough of an improvement that I'll commit it anyway for now.
2018-11-16 03:13:33 -05:00
You can find the mailing list archives here:
<http://groups.google.com/group/redo-list>
It might not look like it, but you can subscribe without having a
Google Account. Just send a message to
`redo-list+subscribe@googlegroups.com` (note the plus sign).
It's okay to send a message directly to the mailing list
without subscribing first. If you reply to someone who writes to the
list, please leave them in the cc: list, since if they
haven't subscribed, they won't get your reply otherwise.
Reference in a new issue Copy permalink