Move content to ./content

So .nix files, etc. are not copied over to generated website.
Plutonomicon · Jan 9, 2022 · a394510 · a394510
1 parent 287be0e
commit a394510
Show file tree

Hide file tree

Showing 26 changed files with 67 additions and 69 deletions.
diff --git a/README.md b/README.md
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+content/index.md
diff --git a/DistributedMap.md → content/DistributedMap.md b/DistributedMap.md → content/DistributedMap.md
diff --git a/assoc.md → content/assoc.md b/assoc.md → content/assoc.md
diff --git a/builtin-data.md → content/builtin-data.md b/builtin-data.md → content/builtin-data.md
diff --git a/builtin-functions.md → content/builtin-functions.md b/builtin-functions.md → content/builtin-functions.md
diff --git a/builtin-lists.md → content/builtin-lists.md b/builtin-lists.md → content/builtin-lists.md
diff --git a/builtin-pairs.md → content/builtin-pairs.md b/builtin-pairs.md → content/builtin-pairs.md
diff --git a/cngproof.md → content/cngproof.md b/cngproof.md → content/cngproof.md
diff --git a/consistency.md → content/consistency.md b/consistency.md → content/consistency.md
diff --git a/forwarding1.md → content/forwarding1.md b/forwarding1.md → content/forwarding1.md
diff --git a/forwarding2.md → content/forwarding2.md b/forwarding2.md → content/forwarding2.md
diff --git a/fundamentals.md → content/fundamentals.md b/fundamentals.md → content/fundamentals.md
diff --git a/content/index.md b/content/index.md
@@ -0,0 +1,65 @@
+<p align="center">
+<br/>
+<img src="https://i.imgur.com/H2ZZjU2.png" height=250 />
+</p>
+
+<h1 align="center">P L U T O N O M I C O N</h1>
+
+## Introduction
+
+The Plutonomicon is a developer-driven guide to the Plutus smart contract language _in practice_.
+
+Since this ecosystem is moving at a breakneck speed, we ask that ANY information posted that is not confirmed to work on chain be labelled as `🔧 work in progress`.
+
+## Available resources
+
+We currently provide the following resources, broadly organized by topic.
+
+### Fundamentals and explanations
+
+* [The Fundamentals of Plutus](fundamentals.md), which gives a brief introduction to the Plutus language.
+* [Plutus Numeric Hierarchy](numeric.md), which gives an overview of the Plutus numerical type class stack, as well as the extensions to it provided by [`plutus-numeric`](https://github.com/Liqwid-Labs/plutus-extra/tree/master/plutus-numeric).
+* [User guide to `plutus-numeric`](user-guide-numeric.md), which gives a more 'example-driven' explanation for how to do certain common tasks using `plutus-numeric`.
+
+### Design patterns
+
+* [Forward Minting Policy](forwarding1.md). Also described [in another  writeup](forwarding2.md). Some caution is required, as you may not wish to directly reference a script to obtain a hash used to identify the two scripts, as this method details.
+* [Come and Go Proof Tokens](cngproof.md)
+* [State Thread Token Pattern](statethread.md)
+* [DistributedMap](DistributedMap.md), describing an on-chain implementation of key-value mappings. This is naive, and mostly designed for conceptual illustration.
+* [Consistency of a Distributed Map](consistency.md), which explains some ways  of operating on a [distributed map](DistributedMap.md).
+* [Stick Breaking Set](stick-breaking-set.md), describing an on-chain method of proving presence or absence in a set.
+* [On-Chain Association List With Constant Time Insert-Removal](assoc.md), describing a pattern that can be used to replicate account-style maps without breaking transaction size limits. This is the optimized version of [the naive   version of that data structure](DistributedMap.md).
+
+### Testing and optimization
+* [Staying In Bounds](size-test.md), which describes the testing interface for Plutus on-chain size provided by [`plutus-size-check`](https://github.com/Liqwid-Labs/plutus-extra/tree/master/plutus-size-check).
+
+#### Script Optimization Techniques:
+* [Reducing Plutus Script Sizes](optimisations.md)
+* [Optimizations to reduce CPU and Mem consumption](scriptmem.md)
+* [Shrinker](https://github.com/Plutonomicon/Shrinker)
+
+### Plutus Vulnerabilities:
+* [Common Plutus Vulnerabilities](vulnerabilities.md)
+
+## Discussion 
+
+To discuss the projects and the content under the Plutonomicon umbrella, join our Discord: https://discord.gg/7rzrymdN
+
+## Building the website
+
+If you'd like run a live version of the website locally:
+
+```
+nix run github:srid/emanote -- -L ./content
+```
+
+As you edit[^ed] and save the Markdown files, the browser view should update instantly without requiring a manual refresh. Run `nix build .#website` to build the statically generated website. See [Emanote guide](https://emanote.srid.ca/guide) for further information.
+
+Please note the Markdown writing conventions:
+
+- There must be zero or one level 1 heading (`# A heading`) as the first line.
+- All other headings must be level 2 or greater.
+- When writing links, use `[foo](foo.md)`, or `[[foo]]`.
+
+[^ed]: Try [Obsidian](https://obsidian.md) or VSCode with [vscode-memo](https://github.com/svsool/vscode-memo) for editing.
diff --git a/index.yaml → content/index.yaml b/index.yaml → content/index.yaml
diff --git a/logo.png → content/logo.png b/logo.png → content/logo.png
diff --git a/numeric.md → content/numeric.md b/numeric.md → content/numeric.md
diff --git a/optimisations.md → content/optimisations.md b/optimisations.md → content/optimisations.md
diff --git a/scriptmem.md → content/scriptmem.md b/scriptmem.md → content/scriptmem.md
diff --git a/size-test.md → content/size-test.md b/size-test.md → content/size-test.md
diff --git a/statethread.md → content/statethread.md b/statethread.md → content/statethread.md
diff --git a/stick-breaking-set.md → content/stick-breaking-set.md b/stick-breaking-set.md → content/stick-breaking-set.md
diff --git a/uplc.md → content/uplc.md b/uplc.md → content/uplc.md
diff --git a/user-guide-numeric.md → content/user-guide-numeric.md b/user-guide-numeric.md → content/user-guide-numeric.md
diff --git a/vulnerabilities.md → content/vulnerabilities.md b/vulnerabilities.md → content/vulnerabilities.md
diff --git a/flake.nix b/flake.nix
@@ -31,7 +31,7 @@
         ''
           mkdir $out
           ${emanote.defaultPackage.${system}}/bin/emanote \
-            --layers "${self};${configDir}" \
+            --layers "${self}/content;${configDir}" \
             gen $out
         '';
       effects = { src }: {

diff --git a/index.md b/index.md