final tidying and readmes

erhant · Oct 2, 2023 · 0d3e2a0 · 0d3e2a0
1 parent c7d861c
commit 0d3e2a0
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 583 deletions.
diff --git a/README.md b/README.md
@@ -106,15 +106,24 @@ Returns the string `"FFD1"`.
 
 ## Testing
 
-Simply do:
+You can use the following commands for testing.
 
 ```sh
-forge test
+# run all tests
+forge test -vvv
+
+# run a specific test
+forge test -vvv --mc PolynomialTest
+forge test -vvv --mc Huffd1Test
 ```
 
-It shall test both the polynomial utilities and the `huffd1` contract.
+I use `-vvv` to see reverts in detail.
+
+## Remarks
+
+- This project was done for the [Huff hackathon](https://huff.sh/hackathon)!
 
-## Further Works
+- This is a very inefficient contract both in contract size and gas usage, and was done mostly for the nerd-snipability factors of using polynomials instead of mappings.
 
 - We can implement approvals with another polynomial too, but time did not permit. Also, there are many optimizations to do in many different places within the code.
 

diff --git a/src/Huffd1.huff b/src/Huffd1.huff
@@ -1,6 +1,8 @@
 /// @title Huffd1
 /// @notice SPDX-License-Identifier: MIT
 /// @author erhant <https://github.com/erhant>
+/// @notice An NFT where instead of mappings we use polynomials
+/// over a finite field with a large prime order.
 
 ///////////////////////////////////////////////////////////////////////////////
 ////                              INCLUDES                                 ////