Skip to content

JohnRillos/wiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

%wiki

An app for building and reading wikis on Urbit.


Proposal 1 (mirror)

Proposal 2 (mirror)

Overview

Changelog

Documentation and release notes can also be viewed in the %docs app.

Installation

|install ~holnes %wiki

Project Structure

src/: Hoon source code. All code here is original and specific to this project.

deps/: Hoon dependencies are pasted into this directory. None of the code here is original to this project.

desk: Contains the name of the desk. App will run and be distributed with this desk name.

_sync.sh: Continuously syncs project files with a desk in a pier.

_dist.sh: Copies project files into your ship's pier.

Building from source

Unix:

  • ./_sync.sh PATH/TO/PIER to sync src/ and deps/ to your dev ship's pier.

Dojo:

  • |commit %wiki to build your desk
  • |install our %wiki to install your desk and start the app for the first time

Distributing the app

  • ./_dist.sh PATH/TO/PIER to copy src/ and deps/ to your distribution ship's pier.
  • Dojo: |commit %wiki