Giter VIP home page Giter VIP logo

tng's Introduction

tng

Introduction

A simple 'tangle' tool in the Literate Programming spirit

The src directory contains two files:

  • tangle_boot.sh to bootstrap the system
  • tangle_lit.sh the literate version of the script above

To build the final version of the script (tng.sh), use the bld script in the root directory:

  ~/tng $ ./bld

To test that everything is working properly use:

  ~/tng $ ./bld test

To cleanup:

  ~/tng $ ./bld clean

Syntax

The syntax is inspired by a post on Kartik Agaram's blog.

  • (code:[filename])
  • (text:[filename]) or just (:)
  • (after:<waypoint>)
  • (before:<waypoint>)
  • (:<waypoint>)
  • (void:<string>) suspend interpretation of directives until next (void:<string>) (with the same string)

Read the source code of tangle_lit.sh for further details and for a live demonstration of how they work.

Note that you can also use quotes within the parenthesis to please your editor/IDE. For example: (':my way point') or ("after: my way point"). (Remember: placing the quote outside the parenthesis will avoid them to be interpreted as directives.)

WARNING Even if this version is language independent, it won't work with Python or any other language for which leading blanks are meaningful.

tng's People

Contributors

rdentato avatar

Watchers

 avatar  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.