Skip to content

Commit

Permalink
Merge pull request #99 from hannobraun/readme
Browse files Browse the repository at this point in the history
Make improvements to README
  • Loading branch information
hannobraun authored Jan 28, 2022
2 parents 7ddb500 + 79c317e commit 331da98
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# Fornjot

[**Website**](https://hannobraun.github.io/Fornjot/) | [**Matrix channel**](https://matrix.to/#/#fornjot:braun-odw.eu) | [**Discussions**](https://github.com/hannobraun/Fornjot/discussions) | [**Contribution Guide**](CONTRIBUTING.md)
[**Blog**](https://www.fornjot.app/blog/) | [**Matrix**](https://matrix.to/#/#fornjot:braun-odw.eu) | [**Discussions**](https://github.com/hannobraun/Fornjot/discussions) | [**Contribution Guide**](CONTRIBUTING.md)

## About

Fornjot is an attempt at creating a **next-generation Code-CAD application**. Because [**the world needs another CAD program**](https://github.com/sponsors/hannobraun).
Fornjot is a project to create a **next-generation Code-CAD application**. Because [**the world needs another CAD program**](https://github.com/sponsors/hannobraun).

![Screenshot of the spacer model](https://github.com/hannobraun/fornjot/blob/main/models/spacer/spacer.png)
![Screenshot of the star model](https://github.com/hannobraun/fornjot/blob/main/models/star/star.png)

Fornjot's development follows the following principles:
Fornjot is working towards a long-term vision, following these principles:

- **Models defined as code**: Program your CAD models like you would program software. Currently, Rust is supported as a modeling language, but Fornjot is architected to be language-agnostic.
- **Advanced modeling features**: Many Code-CAD programs have a very limited feature set. At this early stage, Fornjot is even worse. But it keeps its options open, by leveraging traditional techniques.
- **Widely portable**: Fornjot is primarily developed on Linux, but the plan is to support all major desktop and mobile platforms, and the web.
- **Open source, permissive license**: Whether you're using Fornjot for fun, or to build a commercial project on top of it, the maximally permissive 0BSD license won't get in your way.
- **Write code to create flexible models:** CAD models in Fornjot are defined as code. Rust is supported as the modeling language, but Fornjot is architected to be language-agnostic.
- **Avoid repetitive work:** With the power of a programming language at your disposal, there's no reason to repeat yourself. Creating intricate models doesn't have to be a monotonous chore.
- **The right tool for your job:** Many other Code-CAD applications come with a limited feature set. At this early stage, Fornjot is even worse, but it is built from the ground up to be able to support even advanced CAD features.
- **Getting out of your way:** Fornjot's job is to assist you, by being available where you need it (with planned support for all major desktop and mobile platforms, and the web), being convenient to use, and having the performance to support your workflow.
- **Free and open source**: Fornjot is open source software, available under a permissive license. Try it out for free, with no strings attached. Modify it to your needs. If it's useful to you, decide for yourself how you want to support its further development.

At some point, I'd like to add **high-performance** to this list, but for now this takes a backseat to adding more features.
It's still early days, and it will take a long time before Fornjot can truly achieve this vision. Please consider supporting the project, by [helping out yourself](CONTRIBUTING.md) or [contributing financially](https://github.com/sponsors/hannobraun).

This is Fornjot's main repository. The [website is maintained in a separate repository](https://github.com/hannobraun/www.fornjot.app).

Expand All @@ -24,7 +25,7 @@ This is Fornjot's main repository. The [website is maintained in a separate repo

Fornjot is supported by [@lthiery](https://github.com/lthiery), [@Yatekii](https://github.com/Yatekii), [@ahdinosaur](https://github.com/ahdinosaur), and [@jessebraham](https://github.com/jessebraham).

Please consider [supporting me too](https://github.com/sponsors/hannobraun), to make Fornjot sustainable long-term.
**Please consider [supporting me too](https://github.com/sponsors/hannobraun), to make Fornjot sustainable long-term.**


## Status
Expand Down

0 comments on commit 331da98

Please sign in to comment.