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

Documentation #45

Open
ipkn opened this issue Jan 8, 2015 · 4 comments
Open

Documentation #45

ipkn opened this issue Jan 8, 2015 · 4 comments
Assignees

Comments

@ipkn
Copy link
Owner

ipkn commented Jan 8, 2015

I think implementing basic features is done and writing documentation is high priority now.

  1. Create Quickstart page.
  2. Create a page for detailed topic.
@ipkn ipkn self-assigned this Jan 8, 2015
@tghosgor
Copy link

Thanks for the great project.

I think project needs to be re-organized to separate the template function declarations headers and template function definitions .inc (or w/e) files. It is easier to use the documentation in the header files (above the methods) than any other wiki.

Also, while the CROW_ROUTE macros are neat, it kind of makes it difficult (if not impossible?) to properly modularize the application. I would rather handle different routes in different files. (i.e. /rpc-auth in rpc_generic.cpp and /rpc-auth rpc_auth.cpp). I think the approach of CppCMS project is way better on this matter.

@coder006
Copy link

coder006 commented Apr 6, 2015

I am considering using crow for one of my projects but i cannot find any documentation except the example on the github page. Is the documentation work in progress or is it yet to be done? How long will it take before the documentation is ready?

@jeaye
Copy link

jeaye commented Apr 16, 2015

@coder006 The documentation is scarce, no doubt. There are examples in the example directory, however. Given good knowledge of C++, these should be sufficient to get you going.

@voidrank
Copy link

It's an excellent project. Thanks!
However, I still have some questions about the documentation. Are all features showed in the example? I didn't find any function or macro for handling request header. And you said basic features is done, so I think you have implemented it in this project but this feature is not showed in the example. Please provide more documentation or examples. Thanks!

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

No branches or pull requests

5 participants