Giter Site home page Giter Site logo

Comments (3)

jacquelinekay avatar jacquelinekay commented on August 27, 2024

A note about documentation: consider putting the steps to reproduce generating the documentation in the top-level README.txt, so that people who clone this repo can get an update version of the docs.

e.g. on Ubuntu Linux 14.04, this sort of worked:

  1. download "hyperlatex.sty" by googling for it
  2. place the .sty file in ~/texmf/tex/latex/commonstuff`
  3. cd <graspit root folder>/doc/hyperlatex/
  4. pdflatex graspit-manual.tex

Though it sounds like you are moving away from this latex-based documentation. Markdown is an easy to learn, portable format, but if you need to port existing documentation that contains equations, formatted matrices, etc. it's not so nice...

Github Pages are a nice solution; we are using them with Jekyll Markdown for ROS 2 design documentation. You get more formatting options than a Github wiki, but at the cost of more complexity. Still simpler than messing around with Rails :)

from graspit.

jvarley avatar jvarley commented on August 27, 2024

Any thoughts on:

https://github.com/fetchrobotics/docs
http://docs.fetchrobotics.com/index.html

https://help.github.com/articles/creating-project-pages-manually/

from graspit.

jvarley avatar jvarley commented on August 27, 2024

done.

from graspit.

Related Issues (20)

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.