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

WIP: README.md tweaks #9

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 33 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,55 @@
# Virtual Satellite 4 - FreeCAD Module

Virtual Satellite 4 - FreeCAD Module is an extension for FreeCAD that allows to create a round-trip engineering workflow with Virtual Satellite.
Virtual Satellite 4 - FreeCAD Module is an extension for [FreeCAD](https://freecadweb.org/), an Open Source 3D Parametric Modeler,
that allows to create a round-trip engineering workflow with Virtual Satellite.

## Project Status

Status [![Build Status](https://travis-ci.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod.svg?branch=development)](https://travis-ci.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod) for *Development* build.
| Master | Development |
|:------:|:-----------:|
|[![Master][master-status]][master-builds]|[![Development][development-status]][development-builds]|

Status [![Build Status](https://travis-ci.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod.svg?branch=master)](https://travis-ci.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod) for *Master* build.
[master-status]: https://travis-ci.org/FreeCAD/FreeCAD.svg?branch=master
[master-builds]: https://travis-ci.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod
[development-status]: https://travis-ci.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod.svg?branch=development
[development-builds]: https://travis-ci.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod

## Purpose

Virtual Satellite 4 FreeCAD Module is an extension to FreeCAD. FreeCAD is an open source mechanical engineering CAD tool. The extension can be easily installed to FreeCAD. It allows to import structural configuration information into FreeCAD and keep it consistently synchronized with Virtual Satellite
The Virtual Satellite FreeCAD Module is an extension/addon for FreeCAD. FreeCAD is an open source mechanical engineering CAD tool.
The extension can be easily installed within FreeCAD
1. allowing to import structural configuration information from Virtual Satellite into FreeCAD.
2. keeping it consistently synchronized with Virtual Satellite

## Requirements

This program is based on FreeCAD and Python. The following infrastructure is required:
- FreeCAD 0.18 and higher (64bit)
- A2plus Workbench 0.4.26 and higher

## Quickstart for users
- Virtual Satellite 4

## Quickstart for Users

If you just want to use Virtual Satellite feel free to download it from the [Releases](https://github.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod/releases) section here on GitHub.
If you just want to get started using the Virtual Satellite FreeCAD module, feel free to download it from the [Releases](https://github.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod/releases) section of the GitHub repository.

## Quickstart for developers
## Quickstart for Developers

1. Create a new folder in the _mod_ subdirectory of FreeCAD.
2. Copy the zip file from the releases into this directory.
3. Unzip the file.
4. Start FreeCAD.
1. Locate your system's default configuration path to FreeCAD
* for example on Linux it is `~/.FreeCAD/`.
If you don't know, obtain it by typing the following into FreeCAD's python console: `FreeCAD.ConfigGet("UserAppData")`
2. `cd path/to/your/.FreeCAD/Mod` directory AKA browse in to your default configuration _Mod_ subdirectory.
3. Download the Virtual Satellite FreeCAD extension code. There are 2 ways you can do this:
3a. Manually download the zip file (from [Releases](https://github.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod/releases)) into this directory and unzip it.
3b. OR use `git clone https://github.com/virtualsatellite/VirtualSatellite4-FreeCAD-mod.git`
4. Start or Restart FreeCAD.

The Virtual Satellite Workbench is now available in FreeCAD
The Virtual Satellite Workbench is now available within the dropdown workbenches menu within FreeCAD.

**Note:** the `git clone` method is recommended since updates are conveniently done with a simple `git fetch` instead of needing to re-download the zip file and unzipping it.

## Travis CI and Releases

Tarvis CI is set-up to start a build job for every branch and every new commit to the repository. It executes all relevant tests. Making a successful pull-request into development requires all tests to pass.
Travis CI is set-up to start a build job for every branch and every new commit to the repository. It executes all relevant tests. Making a successful pull-request into development requires all tests to pass.

Starting a Travis CI job on development deploys all relevant artifacts.

Expand All @@ -42,10 +58,10 @@ For creating a new release, create a tag starting with *Release_* on the *master
## Provided Features

- A new Virtual Satellite Workbench
- Functionality to uplaod a design to Virtual Satellite.
- Functionality to upload a design to Virtual Satellite.
- Functionality to download a design from Virtual Satellite.

## Contribution
## Contributing

We are happy to receive your contributions. Nevertheless in such a big project there is a lot to respect and to obey.
One thing to respect are legal requirements such as authorship rights and privacy protection.
Expand Down Expand Up @@ -80,4 +96,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
along with this program. If not, see <https://www.gnu.org/licenses/>.