Giter Club home page Giter Club logo

template's Introduction

Using the repository template

Pre-requisites:

The easiest way to install some of the applications above is to use Homebrew on Mac OS and Linuxbrew on Linux, as they will set up the PATH variable for you, e.g., brew install scons.

To run:

  • The entire directory:
    • In the root directory, type scons in the command line. This should run everything that is flagged as being modified or with dependencies that have been modified.
  • A single directory of targets:
    • scons build/data will re-build the build/data folder if it is out of sync, without rebuilding other files.
  • A single target file:
    • scons build/paper/paper.pdf will re-run only the code needed to update build/paper/paper.pdf without rebuilding other files.

See here for directions on making a 'release'.

Copy the template:

In order to create a new repository using this template, either

  • First, either:
    • Fork this repository
    • Create an empty repository in GitHub and clone it locally. Copy the contents of this template into the empty repository. Make sure to exclude the .git folder, but include the .gitattributes and .gitignore files. Re-run the entire directory using Scons. Commit and push to the new repository.
  • Setup a user-config.yaml in the root of the directory (note that this file should not be versioned):
    • MacOS or Linux minimal working example
    stata_flavor: statamp
    cache: /Users/leviboxell/Google Drive/cache/template
    
    • Windows 10 minimal working example (note the quotation marks)
    stata_flavor: "%STATAEXE%"
    cache: C:\Users\Levi Boxell\Google Drive\cache\template
    

License

The MIT License (MIT)

Copyright (c) 2016 Matthew Gentzkow, Jesse Shapiro

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

template's People

Contributors

lboxell avatar yuchuan2016 avatar arosenbe avatar qlquanle avatar

Watchers

James Cloos 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.