linkVisual Computing Template

Welcome to the UN / DISI visual computing course template site.

linkGoal

To study the process of creation and manipulation of a digital image of a modern visual application, using current hardware.

linkMethodology

Active-learning using free-software to develop:

• Slides.
• nub and p5.nub.js.
• p5.quadrille.js.

linkGrading

Workshops blog posts-like reports produced with codedoc and p5.js and having a basic research structure:

• Problem statement
• Background
• Code (solution) & results
• Conclusions & future work

linkOutline

linkHacking

The webpage is to be developed in markdown (CommonMark and GitHub Flavored Markdown) at the main branch of your https://github.com/<gh-username>/vc repo using codedoc, and the resulting webpage served from the gh-pages branch of that repo at: https://<gh-username>.github.io/vc/. Refer to the gh-pages documentation for details.

1. Install codedoc:

   1linknpm i -g @codedoc/cli
   
   

2. Fork and clone the vc repo using the github web interface, or the cli:

   1linkgh repo clone VisualComputing/vc
   
   2linkcd vc
   
   3link# --> Created fork will be <gh-username>/vc:
   
   4linkgh repo fork #@see https://cli.github.com/manual/gh_repo_fork
   
   

   Note that the cloned repo already contains the codedoc-p5-plugin which is being developed separately here.
3. Enable the workflow action using the github web interface of your https://github.com/<gh-username>/vc cloned repo.
4. Install codedoc dependencies (don't forget to cd vc if you haven't already):

   1linkcodedoc install
   
   

5. Edit your <gh-username> at the github section of the .codedoc/config.ts file, replacing visualcomputing with your <gh-username>.

   config.ts
   1linkexport const config = configuration({
   
   2link  // ..
   
   3link  misc: {
   
   4link    github: {
   
   5link      user: 'gh-username', // --> name of the user on GitHub owning the repo
   
   6link      // ..
   
   7link    }
   
   8link  },
   
   9link  // ..
   
   10link});
   
   

6. Run locally with:

   1linkcodedoc serve
   
   

   Note: to also run the p5.js sketches locally link dist/docs/sketches to the sketches folder.
   1. In Linux:

      1linkcd dist/docs/
      
      2linkln -s ../../docs/sketches
      
      

   2. In Windows (from the cli as administrator):

      1linkcd dist/docs/
      
      2linkMklink /D sketches ".\..\..\docs\sketches"
      
      

7. Deploy to github:

   1linkgit push #@see https://github.com/VisualComputing/vc/blob/main/.github/workflows/deploy-to-gh-pages.yml
   
   

   The page should soon be available at: https://<gh-username>.github.io/vc/