Git Product home page Git Product logo

x-carve-instructions's Introduction

This is the official documentation for assembling [X-Carve] (https://www.inventables.com/technologies/x-carve/), a 3D carving kit from [Inventables] (https://www.inventables.com/). Like X-Carve itself, these instructions are open-source.

If you have experience with Github, feel free to fork this branch and submit a pull request. The instructions are built using [Jekyll] (http://jekyllrb.com/) and are formatted using [Textile] (http://redcloth.org/textile) (with some HTML mixed in).

It's also possible to suggest changes through Github itself. Each step of the instructions is generated from a file named index.textile, contained inside the folder for that step (eg step02/index.textile). The one exception is the file for the first step, which is index.textile inside the main x-carve-instructions folder.

Find the index.textile file for the step you'd like to edit, and click the pencil icon in the top right. This will let you fork a branch and make changes right in the browser. You can then submit a pull request to have your changes reviewed and integrated. [Learn more about pull requests here] (https://help.github.com/articles/using-pull-requests).

If you prefer, you can also submit a Github issue using the menu to the right:

Github issues!

Local Installation

Setting up the site on your local machine:

  1. $ gem install bundler - Install bundler ruby gem
  2. $ git clone https://github.com/inventables/x-carve-instructions.git - Clone project
  3. $ cd x-carve-instructions - Switch to project directory
  4. $ bundle install - Install the necessary gems
  5. $ bundle exec jekyll serve - Serve site locally using Jekyll
  6. go to http://localhost:4000

x-carve-instructions's People

Contributors

johndudleyhayes avatar griffindennis avatar cfinke avatar paulkaplan avatar barnabywalters avatar nevernormal1 avatar development-inventables avatar pjamestx avatar tleswing avatar geocom avatar

Watchers

Justin Spelman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.