Provide basic user-facing documentation

[hannobraun]

There should be some basic user-facing documentation. It can be hosted on the website.

Eventually, this should be a comprehensive resource, but for a start, the following information should be enough:

• What is Fornjot?
• How to install it
• How to get started
• Further reading
  • API documentation of fj crate
  • Models in repository

Maybe an example of using it together with common tools, like VS Code and Git, would also be good.

[ph4ni]

I think you should at least have a one-line intro to Fornjot in the about section because that's what people look at as soon as they visit the repo. Example: The world needs another CAD program. Fornjot is an early-stage project to create a next-generation, code-first Computer-aided design (CAD) application. (I am using this for the Console interview).

[hannobraun]

Okay, you've convinced me 😄

What do you think about the new version?

[ph4ni]

looks much better! Also, can you try adding basic installation instructions? I wanted to try it out but I had no idea where to start.

[hannobraun]

There's a Usage section in the README, but I see that it's out of date and doesn't cover installation. I'll take a look later!

[hannobraun]

I've just submitted a pull request that updates and expands the Usage section in the README.

[hannobraun]

This issue is no longer applicable. See A New Direction for context.