Improve docs #117
Merged
Improve docs #117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jbaylina
approved these changes
Oct 16, 2024
eduadiez
added a commit
that referenced
this pull request
Oct 17, 2024
commit 685eda7 Merge: c1f72c9 8a14775 Author: Eduardo Antuña Díez <[email protected]> Date: Thu Oct 17 17:21:09 2024 +0200 Merge pull request #120 from 0xPolygonHermez/fractasy_develop_3 Default ziskemu n=1000000000. Round up memory read regions to 8n. commit 8a14775 Author: fractasy <[email protected]> Date: Thu Oct 17 15:08:23 2024 +0000 Fix cargo fmt commit 5a37798 Author: fractasy <[email protected]> Date: Thu Oct 17 14:59:47 2024 +0000 Default ziskemu n=1000000000. Round up memory read regions to 8n. commit c1f72c9 Merge: ff72d62 362e917 Author: Eduardo Antuña Díez <[email protected]> Date: Wed Oct 16 17:13:40 2024 +0200 Merge pull request #118 from 0xPolygonHermez/edu_improve_docs Update quickstart.md with additional setup instructions commit 362e917 Author: Eduardo Antuña Díez <[email protected]> Date: Wed Oct 16 15:12:04 2024 +0000 Update quickstart.md with additional setup instructions commit ff72d62 Merge: 4de69a2 e2d3961 Author: Eduardo Antuña Díez <[email protected]> Date: Wed Oct 16 16:11:37 2024 +0200 Merge pull request #117 from 0xPolygonHermez/edu_improve_docs Improve docs commit e2d3961 Author: Eduardo Antuña Díez <[email protected]> Date: Wed Oct 16 13:55:50 2024 +0000 add circom requirement commit a72a7e2 Author: Eduardo Antuña Díez <[email protected]> Date: Wed Oct 16 13:46:21 2024 +0000 minor doc changes commit 6f19b70 Author: Eduardo Antuña Díez <[email protected]> Date: Wed Oct 16 13:24:54 2024 +0000 Improve docs commit 4de69a2 Author: Roger Taulé Buxadera <[email protected]> Date: Wed Oct 16 12:31:00 2024 +0200 Updating quick start and quick start dev (#116) commit ad59fe6 Merge: aabcdd0 e59e8d3 Author: Xavier Pinsach <[email protected]> Date: Wed Oct 16 11:25:13 2024 +0200 Merge pull request #115 from 0xPolygonHermez/temporal-fix cargo update + remove .elf restriction in main_sm commit e59e8d3 Author: Xavier Pinsach <[email protected]> Date: Wed Oct 16 09:16:38 2024 +0000 cargo update + remove .elf restriction in main_sm commit aabcdd0 Merge: d79f55c 85423e8 Author: Eduardo Antuña Díez <[email protected]> Date: Tue Oct 15 18:19:39 2024 +0200 Merge pull request #114 from 0xPolygonHermez/edu/remove_private_token Update the documentation links in the README.md and remove the requir… commit 85423e8 Author: Eduardo Antuña Díez <[email protected]> Date: Tue Oct 15 16:13:39 2024 +0000 refactor: Update git clone command in build_toolchain.rs commit 88fe108 Author: Eduardo Antuña Díez <[email protected]> Date: Tue Oct 15 16:10:16 2024 +0000 docs: Update installation requirements and add macOS warning commit 27b5b0d Author: Eduardo Antuña Díez <[email protected]> Date: Tue Oct 15 16:06:50 2024 +0000 Update the documentation links in the README.md and remove the requirement for private tokens commit d79f55c Merge: e702233 b81b133 Author: Eduardo Antuña Díez <[email protected]> Date: Tue Oct 15 17:18:05 2024 +0200 Merge pull request #113 from 0xPolygonHermez/edu/add_license docs: Add WIP warning and licenses to README.md commit b81b133 Author: Eduardo Antuña Díez <[email protected]> Date: Tue Oct 15 14:37:17 2024 +0000 docs: Add WIP warning and licenses to README.md commit e702233 Merge: 62d8387 5f49082 Author: Andrew Borg (Kashin) <[email protected]> Date: Thu Oct 10 11:15:19 2024 +0100 Merge pull request #108 from 0xPolygonHermez/osx_req docs: Document OSX requirements commit 5f49082 Author: Andrew Borg <[email protected]> Date: Wed Oct 9 10:28:01 2024 +0100 docs: Document OSX requirements commit 62d8387 Author: Roger Taulé Buxadera <[email protected]> Date: Wed Oct 9 17:42:33 2024 +0200 Keeping compatibility with proofman logging changes (#109) * Keeping compatibility with proofman logging changes commit af5e7b4 Merge: 611fd0b 8ffe16b Author: Eduardo Antuña Díez <[email protected]> Date: Tue Oct 8 15:19:08 2024 +0200 Merge pull request #107 from 0xPolygonHermez/edu/doc_improvements Edu/doc_improvements commit 8ffe16b Author: Eduardo Antuña Díez <[email protected]> Date: Tue Oct 8 13:07:40 2024 +0000 Update quickstart.md with additional setup instructions and dependencies commit f0ad21e Author: Eduardo Antuña Díez <[email protected]> Date: Tue Oct 8 13:06:22 2024 +0000 Remove Quickstart DEV from SUMMARY.md and update install.md with additional Ubuntu prerequisites and nodejs installation steps commit 611fd0b Merge: dfa91f3 75170c0 Author: Eduardo Antuña Díez <[email protected]> Date: Tue Oct 8 09:37:28 2024 +0200 Merge pull request #105 from 0xPolygonHermez/edu/improve_docs Update GitHub access token variable names, improve docs and make emu … commit 75170c0 Author: Eduardo Antuña Díez <[email protected]> Date: Mon Oct 7 17:57:39 2024 +0000 Update GitHub access token variable names, improve docs and make emu default option commit dfa91f3 Author: Xavier Pinsach <[email protected]> Date: Mon Oct 7 18:34:31 2024 +0200 Merging feature/binary_checkpoint to develop (#104) * update pil to enable binary tables and pil transpilation feature * Fixing ids * Updating binary table * get binary tables num rows from pil-helpers * update pil-helpers, small fixes & improve output on binary tables, cargo update * improve console output and remove no needed proofman-hints (#94) * Calculate row in binary basic table SM * Fix last binary basic SM bugs; now manual trace tests pass * First fixes to binary extension table SM * Fix binary extended table constants generation * fix missalignment in opcodes * improve binary state machines --------- Co-authored-by: zkronos73 <[email protected]> Co-authored-by: Héctor Masip <[email protected]> Co-authored-by: fractasy <[email protected]> Co-authored-by: zkronos73 <[email protected]> commit 2672593 Author: Xavier Pinsach <[email protected]> Date: Thu Oct 3 18:20:38 2024 +0200 add quickstart_dev.md (#103) commit 446501d Author: Xavier Pinsach <[email protected]> Date: Thu Oct 3 16:43:26 2024 +0200 fix main num_rows (#102) * fix main num_rows commit b2d9d79 Author: zkronos73 <[email protected]> Date: Thu Oct 3 16:18:46 2024 +0200 Feature/update pil mem (#80) * update memory pil * update pilout and fmt of helpers * updated pil-helpers * remove duplicated constant --------- Co-authored-by: Xavier Pinsach <[email protected]> commit 35003fd Author: Xavier Pinsach <[email protected]> Date: Thu Oct 3 14:41:01 2024 +0200 simplify machine constructions (#101) commit 4f55037 Author: Xavier Pinsach <[email protected]> Date: Thu Oct 3 12:57:36 2024 +0200 main working (#100) * main working commit bdedbc7 Author: Xavier Pinsach <[email protected]> Date: Wed Oct 2 19:10:39 2024 +0200 added initialise logger function (#98) commit 734db82 Merge: 02de248 22d4f9f Author: agnusmor <[email protected]> Date: Mon Sep 30 20:26:13 2024 +0200 Merge pull request #96 from 0xPolygonHermez/edu/fix_stable Refactor assembly code to use hexadecimal constants commit 22d4f9f Author: Eduardo Antuña Díez <[email protected]> Date: Mon Sep 30 17:46:09 2024 +0000 Refactor assembly code to use hexadecimal constants commit 02de248 Merge: 0d192cb 8fe51bf Author: Sam Johnson <[email protected]> Date: Mon Sep 30 12:44:39 2024 -0400 Merge pull request #85 from 0xPolygonHermez/sam-op-macro completely re-work ops commit 0d192cb Author: Xavier Pinsach <[email protected]> Date: Mon Sep 30 08:42:52 2024 +0200 remove no needed proofman-hints (#95) commit 8fe51bf Author: Sam Johnson <[email protected]> Date: Thu Sep 26 15:37:07 2024 -0400 re-add local dev lines commit 8bad8d2 Author: Eduardo Antuña Díez <[email protected]> Date: Thu Sep 26 18:00:15 2024 +0000 Add --all-features to releases commit e72b921 Author: Eduardo Antuña Díez <[email protected]> Date: Thu Sep 26 17:53:22 2024 +0000 Fix Refactor GitHub Actions workflow to use stable Rust toolchain commit 095d6bb Author: Eduardo Antuña Díez <[email protected]> Date: Thu Sep 26 17:48:51 2024 +0000 Refactor GitHub Actions workflow to use stable Rust toolchain commit af20cb1 Author: Sam Johnson <[email protected]> Date: Thu Sep 26 13:07:55 2024 -0400 ensure cargo test is run with --workspace commit d81650e Author: Sam Johnson <[email protected]> Date: Thu Sep 26 12:57:47 2024 -0400 fix CI commit bddc156 Author: Sam Johnson <[email protected]> Date: Thu Sep 26 12:13:28 2024 -0400 clean up commit 21b5523 Merge: 497d344 a680ea2 Author: Sam Johnson <[email protected]> Date: Thu Sep 26 12:08:26 2024 -0400 Merge remote-tracking branch 'origin/develop' into sam-op-macro commit a680ea2 Author: Eduardo Antuña Díez <[email protected]> Date: Thu Sep 26 13:17:23 2024 +0200 use rust stable (#81) * use rust stable * add nightly for fmt * add rust-toolchain.toml * Refactor GitHub Actions workflow to remove nightly toolchain --------- Co-authored-by: Xavier Pinsach <[email protected]> commit 673a99c Author: Xavier Pinsach <[email protected]> Date: Thu Sep 26 12:40:30 2024 +0200 New api2 ready (#93) * add basic_table and extension_table sm * Fixing a bug in binary * rename new *_table_sm to binary_*_table_sm * Add F to Provable trait * add F to state machines * Add memory and registry counters to stats * Fix binary basic table required data generation * Binary extension table executor first version * adding binary instances * Implement BinaryExtensionSM trace out pol --------- Co-authored-by: Xavier Pinsach <[email protected]> * Integrate new main.pil from zkronos with SP disabled * Fix a_imm1 and b_imm1 in Emu::step_slice() * fix chunk size * Set up git private repo access configuration * Update git config to use ZISK_CI_TOKEN for authentication * Final refactor of binary extension PIL * change AbtractField to Field * More gsum bug fixing * change AbtractField to Field for the others state machines * Clean all binary SMs gsum errorsgit status * Add operation_bus_enabled to main.pil * avoid to add binary table instances * changing pil2-components to pil2-proofman * comment feature sp * use ziskemu binary only when testing emulator * adding no_lib_link feature * add no_lib_link to ziskemu --------- Co-authored-by: Héctor Masip <[email protected]> Co-authored-by: fractasy <[email protected]> Co-authored-by: fractasy <[email protected]> Co-authored-by: Eduardo Antuña Díez <[email protected]> commit 497d344 Author: Sam Johnson <[email protected]> Date: Tue Sep 24 13:21:59 2024 -0400 make more functions const commit 92677bd Author: Sam Johnson <[email protected]> Date: Tue Sep 24 13:09:01 2024 -0400 update op codes commit e320765 Author: Sam Johnson <[email protected]> Date: Fri Sep 20 10:34:28 2024 -0400 cargo fmt commit 9d29b7b Author: fractasy <[email protected]> Date: Fri Sep 20 10:42:35 2024 +0000 Add ZiskOp::get_call_function() and use it from ZiskInstBuilder::op() commit f98999f Author: Sam Johnson <[email protected]> Date: Thu Sep 19 14:35:10 2024 -0400 fix warnings commit 46fca25 Author: Sam Johnson <[email protected]> Date: Thu Sep 19 14:26:51 2024 -0400 apply clippy fixes commit 8d1244d Author: Sam Johnson <[email protected]> Date: Thu Sep 19 14:25:07 2024 -0400 fix compile errors commit 214cac3 Merge: 2758a51 38e803b Author: Sam Johnson <[email protected]> Date: Thu Sep 19 14:16:40 2024 -0400 Merge remote-tracking branch 'origin/develop' into sam-op-macro commit 38e803b Author: Xavier Pinsach <[email protected]> Date: Mon Sep 16 11:35:33 2024 +0200 Add instance repository (#88) * add instance repository * update and add new pilout commit 6626381 Author: Xavier Pinsach <[email protected]> Date: Mon Sep 16 09:36:42 2024 +0200 renamed pil/fork* -> pil/v* (#86) commit 2758a51 Author: Sam Johnson <[email protected]> Date: Fri Sep 13 17:00:31 2024 -0400 more commit cae4171 Author: Sam Johnson <[email protected]> Date: Fri Sep 13 16:50:57 2024 -0400 upgrade stats.rs to use the new types commit 0e61d4f Author: Sam Johnson <[email protected]> Date: Fri Sep 13 15:53:53 2024 -0400 almost commit 8d07d45 Author: Sam Johnson <[email protected]> Date: Fri Sep 13 15:34:43 2024 -0400 finalize ops, start removing old code commit f115235 Author: Sam Johnson <[email protected]> Date: Fri Sep 13 15:25:52 2024 -0400 add ZiskOp::execute commit e02697b Author: Sam Johnson <[email protected]> Date: Fri Sep 13 14:57:06 2024 -0400 add all ops commit 7a71234 Author: Sam Johnson <[email protected]> Date: Fri Sep 13 14:02:30 2024 -0400 add comment commit af385ed Merge: 06dd597 8a83f31 Author: Sam Johnson <[email protected]> Date: Fri Sep 13 13:58:47 2024 -0400 Merge remote-tracking branch 'origin/develop' into sam-op-macro commit 06dd597 Author: Sam Johnson <[email protected]> Date: Fri Sep 13 13:58:31 2024 -0400 import define ops code commit 7a7403f Author: Sam Johnson <[email protected]> Date: Fri Sep 13 13:43:51 2024 -0400 make zisk operations public for convenience commit c3536f9 Author: Sam Johnson <[email protected]> Date: Fri Sep 13 13:26:58 2024 -0400 set ops as const fns where possible commit 8a83f31 Author: Xavier Pinsach <[email protected]> Date: Fri Sep 13 19:14:51 2024 +0200 updated pil-helpers (#84) commit 291ea04 Author: fractasy <[email protected]> Date: Fri Sep 13 12:09:11 2024 +0200 Improve binary basic executor (#78) * Create ZiskInst::op_type() * First draft of keccak precompiled, backup (requires severe code cleanup) * Call opcode_execute from binary basic SM * Fix shift direction in Emu::step_slice() * Improve binary basic SM * First implementation of binary extensions SM executor commit 68898c2 Author: Sam Johnson <[email protected]> Date: Thu Sep 12 16:59:34 2024 -0400 use nightly channel so the workspace compiles commit ad7a5c9 Merge: f0d8474 7adce52 Author: zkronos73 <[email protected]> Date: Thu Sep 12 19:19:41 2024 +0200 Merge pull request #79 from 0xPolygonHermez/feature/pil-binary-update-2 Feature/pil binary update 2 commit 7adce52 Author: zkronos73 <[email protected]> Date: Thu Sep 12 18:46:57 2024 +0200 update format of generated files commit 1b62a3c Author: zkronos73 <[email protected]> Date: Thu Sep 12 18:46:20 2024 +0200 update binary pils commit f0d8474 Author: Xavier Pinsach <[email protected]> Date: Wed Sep 11 09:31:14 2024 +0200 Main working (#77) * Simple proof working * Fixing constraints flag. Main is passing with 20 instances Co-authored-by: RogerTaule <[email protected]> commit 367e45c Author: fractasy <[email protected]> Date: Mon Sep 9 14:52:56 2024 +0200 First Keccak precompiled. Binary basic draft. (#76) * Create ZiskInst::op_type() * First draft of keccak precompiled * Call opcode_execute from binary basic SM * Fix shift direction in Emu::step_slice() commit 7044d6f Author: Xavier Pinsach <[email protected]> Date: Mon Sep 9 14:26:01 2024 +0200 Feature/thread controller (#75)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.