Skip to content

Commit 139ab8e

Browse files
committed
more docs
1 parent db5dfbc commit 139ab8e

4 files changed

Lines changed: 31 additions & 15 deletions

File tree

README.rst

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,14 @@ Solid Node
2020

2121

2222

23-
A framework to create parametrical mechanical projects with Free Software
24-
23+
**The Free Software framework for parametric 3D printable mechanical projects**
2524

2625
* Free software: GNU Affero General Public License v3
2726
* Documentation: https://solid-node.readthedocs.io.
2827

29-
Introduction
30-
============
31-
32-
There are several technologies that allow the creation of parametric solids
33-
using Free Software, namely OpenScad, CadQuery and Solid Python. When it comes
34-
to mechanical projects, each technology has a different set of libraries available,
35-
and each has its pros and cons. Whichever your choice, they all face limitations
36-
soon. Solid Node proposes an architecture to organize mechanical projects so that
37-
different technologies can be combined, relation between components can be tested,
38-
and individual pieces can be rendered for optimization.
39-
4028
Quickstart
4129
==========
4230

43-
Start by cloning `solid-seed <https://github.com/LibreSolid/solid-seed>_`.
44-
Follow instructions from the README file there.
31+
Start by cloning `solid-seed <https://github.com/LibreSolid/solid-seed>`_.
32+
33+
See `the docs <https://solid-node.readthedocs.io`_.

docs/contributing.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
.. _contributing:
3+
4+
============
5+
Contributing
6+
============
7+
8+
9+
Issues, PRs and discussions can be posted at the project's `Github page <https://github.com/LibreSolid/solid-node>`_

docs/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ Solid Node documentation
88
why-solid-node
99
quickstart
1010
using-solid-node
11+
status-and-roadmap
12+
contributing

docs/status-and-roadmap.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
.. _status-and-roadmap:
3+
4+
==============
5+
Project status
6+
==============
7+
8+
This project has been developed and maintained by a single person so far, and as it is, it's pretty usable. It can already solve real bottlenecks in mechanical project development. It's still a bit far from 1.0 version, but the **current node API should not change** until there.
9+
10+
Roadmap
11+
=======
12+
13+
* Improve the web viewer with workplanes, rulers, camera angles, animation control, etc
14+
* A "dist" command that packs the project into a distributable with source and builds
15+
* A "publish" command that creates a static website with docstrings, viewer, source and build downloads
16+
* Separate the watcher and builder internal processes to recover from errors

0 commit comments

Comments
 (0)