English documentation

[wbuck]

I watched your talk at CppCon 2018 and I really like the look of this framework. The only thing holding me back from using it is the lack of English documentation.

[qicosmos]

@wbuck I will write the English document in few weeks, hope more and more people use feather to develop web application

[wbuck]

Awesome, I'm really looking forward to using this framework for an upcoming project I have

[qicosmos]

@wbuck I have wrote a part of the English documentation, not finished yet, please give me feedback, i need to know if it is clear enough.

https://github.com/qicosmos/feather/blob/master/feather_en.md

Compare with coding, writing documentation is boring, but it must be done :)
Feel free to correct me, thanks!

[wbuck]

I'm at work now, I'll go through the documentation tonight and let you know. Thanks

[wbuck]

I'm just going through the documentation you have thus far but i'm a little unclear with the following:

The http component cinatra rely on the uuid library, so you uuid library is necessary. It also rely on zlib, but zlib is necessary otherwise you want to use gzip.

To be clear, are you saying you must have either the zlib or gzip library installed in order to build?

[qicosmos]

There is a compile switch for gzip, so if you want to use gzip, you sholud open the switch in cmakelists.txt firstly, secondly you need install zlib.

If you don't want to use gzip, close the switch, and you don't need install gzip.

uuid is always needed.

I have updated the document to clearify the gzip library.

[axx]

I've started to have a look at feather and tried to document my baby steps here:
https://medium.com/@allistersanchez/web-app-development-with-modern-c-part-1-1874158ec449
In this first article I started with the use of cinatra, built on an Ubuntu container. I hope you guys find it helpful (and perhaps I could use some of your suggestions as well). :)

[qicosmos]

@axx I looked at the document, it's great, hope you could continue to write the documents, thank you very much.
Of course i will support you, feel free to ask me questions if you have some problems.
If you finish all the documents, i will put it as the English document of feather.

[MattHarrington]

I cleaned up some of the English documentation. I followed a naming convention I saw in other projects. README.en.md contains the English version. Links at the top of each README allow the user to select different languages.

I also created a docs folder. Unfortunately this appears to have broken links from the README files.

Would you consider organizing the files and directories more? For example, your top level could have docs, demos, src, README, and CMakeLists.txt files. The purecpp example appears to be spread out among several directories.

[qicosmos]

There is a docs directory now.
Could you put your documents in the docs directory, and make a link in the README.md?

[suvidh]

@qicosmos are websites created using this framework "secure" as in they use HTTPS? if so how to use SSl?

[opakaj]

https://github.com/qicosmos/cinatra/blob/master/example/main.cpp#L37