Giter Club home page Giter Club logo

applescriptsexperiments's Introduction

Docs

Personal collection of development related notes, snippets, and workflows

Structure

See docs/contents.rim

It's a graph-structure:

  • each folder is a subject and can contain an index file "\(folder.name).rim"
  • each folder can contain subfolders, denoted top-level-subject.subject.sub-subject...
  • naming
    • lower-case, dashes instead of spaces
    • singular; eg. folder containing examples: app.java.example.hello-world
    • logical units; eg. app.web.browser.chrome instead of eg. web-browser.chrome
  • if a block in the index file gets large (eg. > ~ half a screen), refactor it out to its own file with ref see ./sub-subject

Workflow:

  • on work with subject.new: add entry/folder/file in graph
  • add note + links etc
  • format note in rim-style language mixed with shell etc; concise and to the point
  • try add some minimal examples if suitable
  • why: to decrease friction of tackling a new subject
  • why: to create a knowledge-base, etc

How to read

Many files are using my rim syntax (WIP, similar to yaml as base), which will soon (if not, please poke me) be available. In the meantime, it's just text :)

Contribute

Feel free to fork and send PR's :)

Copyright © Leonard Pauli, 2018

Licence: GNU Affero General Public License v3.0

(except when noted otherwise, eg. external submodules etc) For commersial / closed-source / custom licencing needs, please contact us.

applescriptsexperiments's People

Contributors

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